Microsoft.ContainerInstance (stable:2018-04-01)

2025/09/26 • 10 new, 10 deleted methods

ContainerGroups_List (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of container groups. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The URI to fetch the next page of container groups. ,
Required: False ,
}
string ,
}
ContainerGroups_ListByResourceGroup (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of container groups. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The URI to fetch the next page of container groups. ,
Required: False ,
}
string ,
}
ContainerGroups_Get (new)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_CreateOrUpdate (new)
Description :  Create or update container groups with specified configurations.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerGroup:
{
Description: The properties of the container group to be created or updated. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}

⚐ Response (201)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_Update (new)
Description :  Updates container group tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
Resource:
{
Description: The container group resource with just the tags to be updated. ,
Required: True ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_Delete (new)
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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}

⚐ Response (204)

{}
Operations_List (new)
Description :  List the operations for Azure Container Instance service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerInstance/operations
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display information of the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource type of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The friendly name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of operations. ,
Required: False ,
}
string ,
}
ContainerGroupUsage_List (new)
Description :  Get the usage for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The identifier for the physical azure location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage result ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage of the resource ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Required: False ,
}
integer ,
name:
{
Description: The name object of the resource ,
Required: False ,
}
{
value:
{
Description: The name of the resource ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ContainerLogs_List (new)
Description :  Get the logs for a specified container instance in a specified resource group and container group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container instance. ,
Required: True ,
}
string ,
tail:
{
Description: The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
content:
{
Description: The content of the log. ,
Required: False ,
}
string ,
}
StartContainer_LaunchExec (new)
Description :  Starts the exec command for a specified container instance in a specified resource group and container group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container instance. ,
Required: True ,
}
string ,
containerExecRequest:
{
Description: The request for the exec command. ,
Required: True ,
}
{
command:
{
Description: The command to be executed. ,
Required: False ,
}
string ,
terminalSize:
{
Description: The size of the terminal. ,
Required: False ,
}
{
row:
{
Description: The row size of the terminal ,
Required: False ,
}
integer ,
column:
{
Description: The column size of the terminal ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
webSocketUri:
{
Description: The uri for the exec websocket. ,
Required: False ,
}
string ,
password:
{
Description: The password to start the exec command. ,
Required: False ,
}
string ,
}
ContainerGroups_List (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of container groups. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The URI to fetch the next page of container groups. ,
Required: False ,
}
string ,
}
ContainerGroups_ListByResourceGroup (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of container groups. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The URI to fetch the next page of container groups. ,
Required: False ,
}
string ,
}
ContainerGroups_Get (removed)
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_CreateOrUpdate (removed)
Description :  Create or update container groups with specified configurations.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerGroup:
{
Description: The properties of the container group to be created or updated. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}

⚐ Response (201)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_Update (removed)
Description :  Updates container group tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
Resource:
{
Description: The container group resource with just the tags to be updated. ,
Required: True ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}
ContainerGroups_Delete (removed)
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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A container group. ,
}
string ,
}

⚐ Response (204)

{}
Operations_List (removed)
Description :  List the operations for Azure Container Instance service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerInstance/operations
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The display information of the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource type of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The friendly name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of operations. ,
Required: False ,
}
string ,
}
ContainerGroupUsage_List (removed)
Description :  Get the usage for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: The identifier for the physical azure location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage result ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage of the resource ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Required: False ,
}
integer ,
name:
{
Description: The name object of the resource ,
Required: False ,
}
{
value:
{
Description: The name of the resource ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ContainerLogs_List (removed)
Description :  Get the logs for a specified container instance in a specified resource group and container group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container instance. ,
Required: True ,
}
string ,
tail:
{
Description: The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
content:
{
Description: The content of the log. ,
Required: False ,
}
string ,
}
StartContainer_LaunchExec (removed)
Description :  Starts the exec command for a specified container instance in a specified resource group and container group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
containerGroupName:
{
Description: The name of the container group. ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the container instance. ,
Required: True ,
}
string ,
containerExecRequest:
{
Description: The request for the exec command. ,
Required: True ,
}
{
command:
{
Description: The command to be executed. ,
Required: False ,
}
string ,
terminalSize:
{
Description: The size of the terminal. ,
Required: False ,
}
{
row:
{
Description: The row size of the terminal ,
Required: False ,
}
integer ,
column:
{
Description: The column size of the terminal ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
webSocketUri:
{
Description: The uri for the exec websocket. ,
Required: False ,
}
string ,
password:
{
Description: The password to start the exec command. ,
Required: False ,
}
string ,
}