Managed Clusters - Run Command
Elküld egy parancsot a felügyelt fürtön való futtatáshoz.
Az AKS létrehoz egy podot a parancs futtatásához. Ez elsősorban privát fürtök esetén hasznos. További információ: AKS-futtatási parancs.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand?api-version=2025-05-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
resource
|
path | True |
string minLength: 1maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ |
A felügyelt fürterőforrás neve. |
subscription
|
path | True |
string (uuid) |
A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie. |
api-version
|
query | True |
string minLength: 1 |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
command | True |
string |
A futtatandó parancs. |
clusterToken |
string |
Az AKS AAD-kiszolgálóalkalmazáshoz kiadott AuthToken. |
|
context |
string |
A parancs által igényelt fájlokat tartalmazó base64 kódolású zip-fájl. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
a parancs az aszinkron mintával fejeződött be, a hely fejléce szerint követve. !!! ez csak autorestre vonatkozik, soha nem kap 200-t ebből az API-ból !! |
|
202 Accepted |
Elfogadott Fejlécek Location: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy miért nem sikerült a művelet. Ha a fürt nem létezik, a rendszer a 404-et (nem található) adja vissza. |
Biztonság
azure_auth
Azure Active Directory OAuth2-folyamat
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
submitNewCommand
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/runCommand?api-version=2025-05-01
{
"command": "kubectl apply -f ns.yaml",
"context": "",
"clusterToken": ""
}
Mintaválasz
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2025-05-01
{
"id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
"properties": {
"provisioningState": "succeeded",
"exitCode": 0,
"startedAt": "2021-02-17T00:28:20Z",
"finishedAt": "2021-02-17T00:28:33Z",
"logs": "namespace dummy created"
}
}
Definíciók
Name | Description |
---|---|
Cloud |
Hibaválasz a Container service-től. |
Cloud |
Hibaválasz a Container service-től. |
Run |
Futtatási parancskérelem |
Run |
parancs eredményének futtatása. |
CloudError
Hibaválasz a Container service-től.
Name | Típus | Description |
---|---|---|
error |
A hibával kapcsolatos részletek. |
CloudErrorBody
Hibaválasz a Container service-től.
Name | Típus | Description |
---|---|---|
code |
string |
A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók. |
details |
A hiba további részleteinek listája. |
|
message |
string |
A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre. |
target |
string |
Az adott hiba célja. Például a tulajdonság neve hibás. |
RunCommandRequest
Futtatási parancskérelem
Name | Típus | Description |
---|---|---|
clusterToken |
string |
Az AKS AAD-kiszolgálóalkalmazáshoz kiadott AuthToken. |
command |
string |
A futtatandó parancs. |
context |
string |
A parancs által igényelt fájlokat tartalmazó base64 kódolású zip-fájl. |
RunCommandResult
parancs eredményének futtatása.
Name | Típus | Description |
---|---|---|
id |
string |
A parancs azonosítója. |
properties.exitCode |
integer (int32) |
A parancs kilépési kódja |
properties.finishedAt |
string (date-time) |
A parancs befejezésének időpontja. |
properties.logs |
string |
A parancs kimenete. |
properties.provisioningState |
string |
kiépítési állapot |
properties.reason |
string |
Annak magyarázata, hogy a provisioningState miért sikertelen (ha igen). |
properties.startedAt |
string (date-time) |
A parancs indításának időpontja. |