Skip to main content

​
List Containers

Retrieve all container instances across subscriptions

​
Response

​
value
array
Array of container objects
​
name
string
Container group name
​
resourceGroup
string
Resource group containing the container
​
location
string
Azure region location
​
status
string
Current state of the container (e.g., “Running”, “Stopped”)
​
image
string
Container image name
​
subscriptionId
string
Azure subscription ID

​
Error Responses

Status Codes:
  • 401 - Unauthorized
  • 500 - Internal server error

​
Create Container

Create a new Azure Container Instance

​
Request Body

​
subscriptionId
string
required
Azure subscription ID
​
rgName
string
required
Resource group name
​
location
string
default:"westeurope"
Azure region for the container
​
cnName
string
required
Container name
​
image
string
required
Container image (e.g., “nginx:latest”, “mcr.microsoft.com/azuredocs/aci-helloworld”)
​
cpu
number
Number of CPU cores (e.g., 0.5, 1.0, 2.0)
​
memory
number
Memory in GB (e.g., 1.0, 1.5, 4.0)
​
port
number
default:80
Exposed port number
​
registry
object
Private registry credentials (optional)
​
server
string
Registry server URL
​
username
string
Registry username
​
password
string
Registry password

​
Response

​
message
string
Success message with container name
​
containerId
string
Full Azure resource ID of the created container

​
Container Configuration

  • OS Type: Linux
  • Restart Policy: Always
  • IP Address Type: Public
  • Protocol: TCP

​
Error Responses

Status Codes:
  • 200 - Container created successfully
  • 400 - Missing required parameters
  • 401 - Unauthorized
  • 500 - Internal server error

​
Restart Container

Restart a running container instance

​
Request Body

​
subscriptionId
string
required
Azure subscription ID
​
resourceGroup
string
required
Resource group name
​
containerName
string
required
Container name to restart

​
Response

​
message
string
Confirmation message

​
Error Responses

Status Codes:
  • 200 - Container restarted successfully
  • 400 - Missing required parameters
  • 401 - Unauthorized
  • 500 - Internal server error

​
Delete Container

Delete a container instance

​
Request Body

​
subscriptionId
string
required
Azure subscription ID
​
resourceGroup
string
required
Resource group name
​
containerName
string
required
Container name to delete

​
Response

​
message
string
Confirmation message

​
Error Responses

Status Codes:
  • 200 - Container deleted successfully
  • 400 - Missing required parameters
  • 401 - Unauthorized
  • 500 - Internal server error

Build docs developers (and LLMs) love

Get started for freeTalk to us