Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Container Exec Spec #2584

Merged
merged 6 commits into from
Mar 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,8 @@
"$ref": "#/definitions/ContainerGroup"
}
}
}
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ContainerGroups_Update",
Expand All @@ -206,6 +207,7 @@
{
"name": "Resource",
"description": "The container group resource with just the tags to be updated.",
"required": true,
"in": "body",
"schema": {
"$ref": "#/definitions/Resource"
Expand Down Expand Up @@ -360,6 +362,56 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

action name exec can be more descriptive. launchExecCommand etc.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exec is the Kubernetes convention.

"post": {
"operationId": "StartContainer_LaunchExec",
"x-ms-examples": {
"ContainerExecStart": {
"$ref": "./examples/ContainerExecStart.json"
}
},
"summary": "Starts the exec command for a specific container instance.",
"description": "Starts the exec command for a specified container instance in a specified resource group and container group.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ContainerGroupNameParameter"
},
{
"name": "containerName",
"in": "path",
"description": "The name of the container instance.",
"required": true,
"type": "string"
},
{
"name":"containerExecRequest",
"in":"body",
"description":"The request for the exec command.",
"required":true,
"schema":{
"$ref":"#/definitions/ContainerExecRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContainerExecResponse"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -1057,6 +1109,44 @@
}
}
},
"ContainerExecRequest": {
"description": "The start container exec request.",
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "The command to be executed."
},
"terminalSize": {
"type": "object",
"description": "The size of the terminal.",
"properties": {
"row":{
"type": "integer",
"description": "The row size of the terminal"
},
"column": {
"type": "integer",
"description": "The column size of the terminal"
}
}
}
}
},
"ContainerExecResponse": {
"description": "The information for the container exec command.",
"type": "object",
"properties": {
"webSocketUri": {
"type": "string",
"description": "The uri for the exec websocket."
},
"password": {
"type": "string",
"description": "The password to start the exec command."
}
}
},
"Resource": {
"type": "object",
"description": "The Resource model definition.",
Expand Down Expand Up @@ -1131,6 +1221,14 @@
"type": "string",
"description": "The name of the container group.",
"x-ms-parameter-location": "method"
},
"OperationIdParameter": {
"name": "operationId",
"in": "path",
"required": true,
"type": "string",
"description": "The operation Id.",
"x-ms-parameter-location": "method"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"subscriptionId": "subid",
"api-version": "2018-02-01-preview",
"resourceGroupName": "demo",
"containerGroupName": "demo1",
"containerName": "container1",
"containerExecRequest": {
"command": "/bin/bash",
"terminalSize": {
"row": 12,
"column": 12
}
}
},
"responses": {
"200": {
"body": {
"webSocketUri": "wss://web-socket-uri",
"password": "password"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parameters": {
"subscriptionId": "subid",
"location": "westcentralus",
"operationId": "operationId",
"api-version": "2018-02-01-preview"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"status": "Creating"
}
}
}
}

2 changes: 1 addition & 1 deletion specification/containerinstance/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ python:
payload-flattening-threshold: 2
namespace: azure.mgmt.containerinstance
package-name: azure-mgmt-containerinstance
package-version: 0.2.0
package-version: 0.4.0
clear-output-folder: true
```
``` yaml $(python) && $(python-mode) == 'update'
Expand Down