Azure Container Instances Subscriptions API
The Subscriptions API from Azure Container Instances — 12 operation(s) for subscriptions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/azure-container-instances-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ContainerInstanceManagementClient Operations Subscriptions API
version: '2.0'
x-apisguru-categories:
- cloud
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
x-origin:
- format: swagger
url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json
x-preferred: true
x-providerName: azure.com
x-serviceName: containerinstance-containerInstance
x-tags:
- Azure
- Microsoft
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: Subscriptions
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups:
get:
description: Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
operationId: ContainerGroups_List
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroupListResult'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Get a List of Container Groups in the Specified Subscription.
x-ms-examples:
ContainerGroupsList:
parameters:
api-version: '2018-10-01'
subscriptionId: subid
responses:
'200':
body:
value:
- id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
instanceView:
currentState:
detailStatus: ''
startTime: '2017-10-17T17:27:21Z'
state: Running
events: []
restartCount: 0
ports:
- port: 80
resources:
requests:
cpu: 1
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
imageRegistryCredentials:
- server: azcloudconsoleregistry.azurecr.io
username: azcloudconsoleregistry
ipAddress:
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
readOnly: false
shareName: share1
storageAccountName: storage1
name: volume1
type: Microsoft.ContainerInstance/containerGroups
x-ms-pageable:
nextLinkName: nextLink
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages:
get:
description: Get the list of cached images on specific OS type for a subscription in a region.
operationId: ListCachedImages
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/LocationParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CachedImagesListResult'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Get the List of Cached Images.
x-ms-examples:
CachedImages:
parameters:
api-version: '2018-10-01'
location: westcentralus
subscriptionId: subid
responses:
'200':
body:
value:
- image: ubuntu:16.04
osType: Linux
- image: alpine:3.6
osType: Linux
- image: microsoft/nanoserver:10.0.14393.2485
osType: Windows
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities:
get:
description: Get the list of CPU/memory/GPU capabilities of a region.
operationId: ListCapabilities
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/LocationParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CapabilitiesListResult'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Get the List of Capabilities of the Location.
x-ms-examples:
GetCapabilities:
parameters:
api-version: '2018-10-01'
location: westus
subscriptionId: subid
responses:
'200':
body:
value:
- capabilities:
maxCpu: 4
maxGpuCount: 4
maxMemoryInGB: 14
gpu: K80
ipAddressType: Public
location: West US
osType: Linux
resourceType: containerGroups
- capabilities:
maxCpu: 4
maxGpuCount: 0
maxMemoryInGB: 14
gpu: None
ipAddressType: Public
location: West US
osType: Windows
resourceType: containerGroups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages:
get:
description: Get the usage for a subscription
operationId: ContainerGroupUsage_List
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/LocationParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsageListResult'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
ContainerUsage:
parameters:
api-version: '2018-10-01'
location: westcentralus
subscriptionId: subid
responses:
'200':
body:
value:
- currentValue: 1
limit: 2000
name:
localizedValue: Container Groups
value: ContainerGroups
unit: Count
summary: Azure Container Instances Container Group Usage_ List
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups:
get:
description: Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
operationId: ContainerGroups_ListByResourceGroup
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroupListResult'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Get a List of Container Groups in the Specified Subscription and Resource Group.
x-ms-examples:
ContainerGroupsListByResourceGroup:
parameters:
api-version: '2018-10-01'
resourceGroupName: demo
subscriptionId: subid
responses:
'200':
body:
value:
- id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
imageRegistryCredentials:
- server: azcloudconsoleregistry.azurecr.io
username: azcloudconsoleregistry
ipAddress:
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
readOnly: false
shareName: share1
storageAccountName: storage1
name: volume1
type: Microsoft.ContainerInstance/containerGroups
x-ms-pageable:
nextLinkName: nextLink
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
: delete:
description: Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.
operationId: ContainerGroups_Delete
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/ContainerGroupNameParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
'204':
description: No Content - the specified container group was not found.
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Delete the Specified Container Group.
x-ms-examples:
ContainerGroupsDelete:
parameters:
api-version: '2018-10-01'
containerGroupName: demo1
resourceGroupName: demo
subscriptionId: subid
responses:
'200': {}
'204': {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
get:
description: Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
operationId: ContainerGroups_Get
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/ContainerGroupNameParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Get the Properties of the Specified Container Group.
x-ms-examples:
ContainerGroupsGet_Failed:
parameters:
api-version: '2018-10-01'
containerGroupName: demo1
resourceGroupName: demo
subscriptionId: subid
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
instanceView:
currentState:
detailStatus: ''
startTime: '2017-08-08T00:09:10Z'
state: Waiting
events:
- count: 1
firstTimestamp: '2017-08-08T00:09:01Z'
lastTimestamp: '2017-08-08T00:09:01Z'
message: pulling image "nginx"
name: Pulling
type: Normal
- count: 1
firstTimestamp: '2017-08-08T00:09:10Z'
lastTimestamp: '2017-08-08T00:09:10Z'
message: Successfully pulled image "nginx"
name: Pulled
type: Normal
restartCount: 0
ports:
- port: 80
resources:
requests:
cpu: 1
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
imageRegistryCredentials:
- server: azcloudconsoleregistry.azurecr.io
username: azcloudconsoleregistry
instanceView:
events:
- count: 1
firstTimestamp: '2017-10-08T00:19:10Z'
lastTimestamp: '2017-10-08T00:19:10Z'
message: 'Output: mount error(2): Permission denied'
name: FailedMount
type: Normal
state: Pending
ipAddress:
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Failed
volumes:
- azureFile:
readOnly: false
shareName: share1
storageAccountName: storage1
name: volume1
type: Microsoft.ContainerInstance/containerGroups
ContainerGroupsGet_Succeeded:
parameters:
api-version: '2018-10-01'
containerGroupName: demo1
resourceGroupName: demo
subscriptionId: subid
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
imageRegistryCredentials:
- server: azcloudconsoleregistry.azurecr.io
username: azcloudconsoleregistry
ipAddress:
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
readOnly: false
shareName: share1
storageAccountName: storage1
name: volume1
type: Microsoft.ContainerInstance/containerGroups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
patch:
description: Updates container group tags with specified values.
operationId: ContainerGroups_Update
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/ContainerGroupNameParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Update Container Groups.
x-ms-examples:
ContainerGroupsUpdate:
parameters:
Resource:
tags:
tag1key: tag1Value
tag2key: tag2Value
api-version: '2018-10-01'
containerGroupName: demo1
resourceGroupName: demoResource
subscriptionId: subid
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
- mountPath: /mnt/volume2
name: volume2
readOnly: false
- mountPath: /mnt/volume3
name: volume3
readOnly: true
imageRegistryCredentials: []
ipAddress:
dnsNameLabel: dnsnamelabel1
fqdn: dnsnamelabel1.azure-container.io
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
shareName: shareName
storageAccountName: accountName
name: volume1
- emptyDir: {}
name: volume2
- name: volume3
secret: {}
tags:
tag1key: tag1Value
tag2key: tag2Value
type: Microsoft.ContainerInstance/containerGroups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Resource'
description: The container group resource with just the tags to be updated.
required: true
put:
description: Create or update container groups with specified configurations.
operationId: ContainerGroups_CreateOrUpdate
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/ContainerGroupNameParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
'201':
description: Created - the container group is created.
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
default:
description: Error response describing why the operation failed.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
summary: Azure Container Instances Create or Update Container Groups.
x-ms-examples:
ContainerGroupsCreateOrUpdate:
parameters:
api-version: '2018-10-01'
containerGroup:
id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
identity:
type: SystemAssigned, UserAssigned
userAssignedIdentities:
? /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name
: {}
location: west us
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
gpu:
count: 1
sku: K80
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
- mountPath: /mnt/volume2
name: volume2
readOnly: false
- mountPath: /mnt/volume3
name: volume3
readOnly: true
diagnostics:
logAnalytics:
logType: ContainerInsights
metadata:
test-key: test-metadata-value
workspaceId: workspaceid
workspaceKey: workspaceKey
dnsConfig:
nameServers:
- 1.1.1.1
options: ndots:2
searchDomains: cluster.local svc.cluster.local
imageRegistryCredentials: []
ipAddress:
dnsNameLabel: dnsnamelabel1
ports:
- port: 80
protocol: TCP
type: Public
networkProfile:
id: test-network-profile-id
osType: Linux
volumes:
- azureFile:
shareName: shareName
storageAccountKey: accountKey
storageAccountName: accountName
name: volume1
- emptyDir: {}
name: volume2
- name: volume3
secret:
secretKey1: SecretValue1InBase64
secretKey2: SecretValue2InBase64
type: Microsoft.ContainerInstance/containerGroups
containerGroupName: demo1
resourceGroupName: demo
subscriptionId: subid
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
gpu:
count: 1
sku: K80
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
- mountPath: /mnt/volume2
name: volume2
readOnly: false
- mountPath: /mnt/volume3
name: volume3
readOnly: true
diagnostics:
logAnalytics:
workspaceId: workspaceid
workspaceKey: ''
dnsConfig:
nameServers:
- 1.1.1.1
options: ndots:2
searchDomains: cluster.local svc.cluster.local
imageRegistryCredentials: []
ipAddress:
dnsNameLabel: dnsnamelabel1
fqdn: dnsnamelabel1.azure-container.io
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
shareName: shareName
storageAccountName: accountName
name: volume1
- emptyDir: {}
name: volume2
- name: volume3
secret: {}
type: Microsoft.ContainerInstance/containerGroups
'201':
body:
id: /subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1
location: WestUs
name: demo1
properties:
containers:
- name: demo1
properties:
command: []
environmentVariables: []
image: nginx
ports:
- port: 80
resources:
requests:
cpu: 1
gpu:
count: 1
sku: K80
memoryInGB: 1.5
volumeMounts:
- mountPath: /mnt/volume1
name: volume1
readOnly: false
- mountPath: /mnt/volume2
name: volume2
readOnly: false
- mountPath: /mnt/volume3
name: volume3
readOnly: true
dnsConfig:
nameServers:
- 1.1.1.1
imageRegistryCredentials: []
ipAddress:
dnsNameLabel: dnsnamelabel1
fqdn: dnsnamelabel1.azure-container.io
ip: 10.0.0.1
ports:
- port: 80
protocol: TCP
type: Public
osType: Linux
provisioningState: Succeeded
volumes:
- azureFile:
shareName: shareName
storageAccountName: accountName
name: volume1
- emptyDir: {}
name: volume2
- name: volume3
secret: {}
type: Microsoft.ContainerInstance/containerGroups
x-ms-long-running-operation: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Subscriptions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContainerGroup'
description: The properties of the container group to be created or updated.
required: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec
: post:
description: Executes a command for a specific container instance in a specifie
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-container-instances/refs/heads/main/openapi/azure-container-instances-subscriptions-api-openapi.yml