Managed Clusters - Run Command

Servicio:

AKS

Versión de la API:

2025-04-01

Envía un comando para ejecutarse en el clúster administrado.
AKS creará un pod para ejecutar el comando. Esto es principalmente útil para los clústeres privados. Para obtener más información, consulte comando de ejecución de AKS.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	Nombre del recurso de clúster administrado.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
command	True	string	Comando que debe ejecutar.
clusterToken		string	AuthToken emitido para la aplicación de servidor de AKS AAD.
context		string	Un archivo ZIP codificado en base64 que contiene los archivos necesarios para el comando.

Respuestas

Nombre	Tipo	Description
200 OK	RunCommandResult	el comando finalizó con el patrón asincrónico, el seguimiento por encabezado de ubicación. !!! esto es solo para autorest, nunca obtendrá 200 de esta API !!
202 Accepted		Aceptado Encabezados Location: string
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación. Si el clúster no existe, se devuelve 404 (no encontrado).

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

submitNewCommand

Solicitud de ejemplo

HTTP

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

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

Python

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/2025-04-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

Respuesta de muestra

status code:

202

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

status code:

200

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio contenedor.
CloudErrorBody	Respuesta de error del servicio contenedor.
RunCommandRequest	Una solicitud de comando de ejecución
RunCommandResult	ejecutar el resultado del comando.

CloudError

Object

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
error	CloudErrorBody	Detalles sobre el error.

CloudErrorBody

Object

Respuesta de error del servicio contenedor.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

RunCommandRequest

Object

Una solicitud de comando de ejecución

Nombre	Tipo	Description
clusterToken	string	AuthToken emitido para la aplicación de servidor de AKS AAD.
command	string	Comando que debe ejecutar.
context	string	Un archivo ZIP codificado en base64 que contiene los archivos necesarios para el comando.

RunCommandResult

Object

ejecutar el resultado del comando.

Nombre	Tipo	Description
id	string	Identificador del comando.
properties.exitCode	integer (int32)	Código de salida del comando
properties.finishedAt	string (date-time)	Hora a la que finalizó el comando.
properties.logs	string	Salida del comando.
properties.provisioningState	string	estado de aprovisionamiento
properties.reason	string	Explicación de por qué provisioningState está establecido en error (si es así).
properties.startedAt	string (date-time)	Hora a la que se inició el comando.