Delen via


Managed Clusters - Run Command

Hiermee verzendt u een opdracht die moet worden uitgevoerd op het beheerde cluster.
AKS maakt een pod om de opdracht uit te voeren. Dit is voornamelijk handig voor privéclusters. Zie AKS Run Commandvoor meer informatie.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

resourceName
path True

string

De naam van de beheerde clusterresource.

Regex-patroon: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

De id van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
command True

string

De opdracht die moet worden uitgevoerd.

clusterToken

string

AuthToken uitgegeven voor AKS AAD Server-app.

context

string

Een met base64 gecodeerd zip-bestand met de bestanden die vereist zijn voor de opdracht.

Antwoorden

Name Type Description
200 OK

RunCommandResult

opdracht voltooid met asynchroon patroon, bijhouden op locatieheader. !!! dit is alleen voor automatisch gebruik, u krijgt nooit 200 van deze API !!

202 Accepted

Geaccepteerd

Kopteksten

Location: string

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. Als het cluster niet bestaat, wordt 404 (niet gevonden) geretourneerd.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

submitNewCommand

Voorbeeldaanvraag

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

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

Voorbeeldrespons

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-10-01
{
  "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
  "properties": {
    "provisioningState": "succeeded",
    "exitCode": 0,
    "startedAt": "2021-02-17T00:28:20Z",
    "finishedAt": "2021-02-17T00:28:33Z",
    "logs": "namespace dummy created"
  }
}

Definities

Name Description
CloudError

Een foutreactie van de Container-service.

CloudErrorBody

Een foutreactie van de Container-service.

RunCommandRequest

Een opdrachtaanvraag uitvoeren

RunCommandResult

opdrachtresultaat uitvoeren.

CloudError

Een foutreactie van de Container-service.

Name Type Description
error

CloudErrorBody

Details over de fout.

CloudErrorBody

Een foutreactie van de Container-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.

details

CloudErrorBody[]

Een lijst met aanvullende informatie over de fout.

message

string

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

target

string

Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

RunCommandRequest

Een opdrachtaanvraag uitvoeren

Name Type Description
clusterToken

string

AuthToken uitgegeven voor AKS AAD Server-app.

command

string

De opdracht die moet worden uitgevoerd.

context

string

Een met base64 gecodeerd zip-bestand met de bestanden die vereist zijn voor de opdracht.

RunCommandResult

opdrachtresultaat uitvoeren.

Name Type Description
id

string

De opdracht-id.

properties.exitCode

integer

De afsluitcode van de opdracht

properties.finishedAt

string

Het tijdstip waarop de opdracht is voltooid.

properties.logs

string

De uitvoer van de opdracht.

properties.provisioningState

string

Inrichtingsstatus

properties.reason

string

Een uitleg van de reden waarom provisioningState is ingesteld op mislukt (als dat het zo is).

properties.startedAt

string

Het tijdstip waarop de opdracht is gestart.