Container - Execute Command

Service:

Container Instances

API Version:

2018-10-01

Executes a command in a specific container instance.
Executes a command for a specific container instance in a specified resource group and container group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec?api-version=2018-10-01

URI Parameters

Name	In	Required	Type	Description
containerGroupName	path	True	string	The name of the container group.
containerName	path	True	string	The name of the container instance.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version

Request Body

Name	Type	Description
command	string	The command to be executed.
terminalSize	TerminalSize	The size of the terminal.

Responses

Name	Type	Description
200 OK	ContainerExecResponse	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

ContainerExec

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1/containers/container1/exec?api-version=2018-10-01

{
  "command": "/bin/bash",
  "terminalSize": {
    "row": 12,
    "column": 12
  }
}

Sample Response

Status code:

200

{
  "webSocketUri": "wss://web-socket-uri",
  "password": "password"
}

Definitions

Name	Description
CloudError	An error response from the Batch service.
CloudErrorBody	An error response from the Batch service.
ContainerExecRequest	The container exec request.
ContainerExecResponse	The information for the container exec command.
TerminalSize	The size of the terminal.

CloudError

An error response from the Batch service.

Name	Type	Description
error	CloudErrorBody	An error response from the Batch service.

CloudErrorBody

An error response from the Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ContainerExecRequest

The container exec request.

Name	Type	Description
command	string	The command to be executed.
terminalSize	TerminalSize	The size of the terminal.

ContainerExecResponse

The information for the container exec command.

Name	Type	Description
password	string	The password to start the exec command.
webSocketUri	string	The uri for the exec websocket.

TerminalSize

The size of the terminal.

Name	Type	Description
cols	integer	The column size of the terminal
rows	integer	The row size of the terminal