Microsoft.ContainerInstance (stable:2021-09-01)

2025/09/26 • 18 new, 18 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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 ,
zones:
{
Description: The zones for the container group. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Restart (new)
Description :  Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart
{
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Stop (new)
Description :  Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop
{
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Start (new)
Description :  Starts all containers in a container group. Compute resources will be allocated and billing will start.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start
{
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 (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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: True ,
}
string ,
display:
{
Description: The display information of the operation. ,
Required: True ,
}
{
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 ,
}
,
properties:
{
Description: The additional properties. ,
Required: False ,
}
object ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListUsage (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:
{
Description: The usage data. ,
Required: False ,
}
[
{
id:
{
Description: Id of the usage result ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage result ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: int32 ,
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ListLogs (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. ,
Format: int32 ,
Required: False ,
}
integer ,
timestamps:
{
Description: If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
content:
{
Description: The content of the log. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ExecuteCommand (new)
Description :  Executes a command for a specific 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 ,
}
{
rows:
{
Description: The row size of the terminal ,
Format: int32 ,
Required: False ,
}
integer ,
cols:
{
Description: The column size of the terminal ,
Format: int32 ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Attach (new)
Description :  Attach to the output stream of a specific 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}/attach
{
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 ,
}

⚐ Response (200)

{
webSocketUri:
{
Description: The uri for the output stream from the attach. ,
Required: False ,
}
string ,
password:
{
Description: The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListCachedImages (new)
Description :  Get the list of cached images on specific OS type for a subscription in a region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages
{
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:
{
Description: The list of cached images. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type of the cached image. ,
Required: True ,
}
string ,
image:
{
Description: The cached image name. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of cached images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListCapabilities (new)
Description :  Get the list of CPU/memory/GPU capabilities of a region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities
{
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:
{
Description: The list of capabilities. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this capability describes. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type that this capability describes. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: The ip address type that this capability describes. ,
Required: False ,
}
string ,
gpu:
{
Description: The GPU sku that this capability describes. ,
Required: False ,
}
string ,
capabilities:
{
Description: The supported capabilities. ,
Required: False ,
}
{
maxMemoryInGB:
{
Description: The maximum allowed memory request in GB. ,
Required: False ,
}
number ,
maxCpu:
{
Description: The maximum allowed CPU request in cores. ,
Required: False ,
}
number ,
maxGpuCount:
{
Description: The maximum allowed GPU count. ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of capabilities. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_GetOutboundNetworkDependenciesEndpoints (new)
Description :  Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints
{
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: Response for network dependencies, always empty list. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 ,
zones:
{
Description: The zones for the container group. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Restart (removed)
Description :  Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart
{
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Stop (removed)
Description :  Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop
{
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_Start (removed)
Description :  Starts all containers in a container group. Compute resources will be allocated and billing will start.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start
{
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 (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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: True ,
}
string ,
display:
{
Description: The display information of the operation. ,
Required: True ,
}
{
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 ,
}
,
properties:
{
Description: The additional properties. ,
Required: False ,
}
object ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListUsage (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:
{
Description: The usage data. ,
Required: False ,
}
[
{
id:
{
Description: Id of the usage result ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage result ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: int32 ,
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ListLogs (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. ,
Format: int32 ,
Required: False ,
}
integer ,
timestamps:
{
Description: If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
content:
{
Description: The content of the log. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_ExecuteCommand (removed)
Description :  Executes a command for a specific 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 ,
}
{
rows:
{
Description: The row size of the terminal ,
Format: int32 ,
Required: False ,
}
integer ,
cols:
{
Description: The column size of the terminal ,
Format: int32 ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Containers_Attach (removed)
Description :  Attach to the output stream of a specific 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}/attach
{
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 ,
}

⚐ Response (200)

{
webSocketUri:
{
Description: The uri for the output stream from the attach. ,
Required: False ,
}
string ,
password:
{
Description: The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListCachedImages (removed)
Description :  Get the list of cached images on specific OS type for a subscription in a region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages
{
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:
{
Description: The list of cached images. ,
Required: False ,
}
[
{
osType:
{
Description: The OS type of the cached image. ,
Required: True ,
}
string ,
image:
{
Description: The cached image name. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of cached images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListCapabilities (removed)
Description :  Get the list of CPU/memory/GPU capabilities of a region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities
{
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:
{
Description: The list of capabilities. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this capability describes. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type that this capability describes. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: The ip address type that this capability describes. ,
Required: False ,
}
string ,
gpu:
{
Description: The GPU sku that this capability describes. ,
Required: False ,
}
string ,
capabilities:
{
Description: The supported capabilities. ,
Required: False ,
}
{
maxMemoryInGB:
{
Description: The maximum allowed memory request in GB. ,
Required: False ,
}
number ,
maxCpu:
{
Description: The maximum allowed CPU request in cores. ,
Required: False ,
}
number ,
maxGpuCount:
{
Description: The maximum allowed GPU count. ,
Required: False ,
}
number ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of capabilities. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContainerGroups_GetOutboundNetworkDependenciesEndpoints (removed)
Description :  Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints
{
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: Response for network dependencies, always empty list. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}