Microsoft.ContainerInstance (preview:2024-05-01)

2025/03/04 • 2 updated methods

ContainerGroups_List (updated)
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 ¶

⚶ Changes

{
  "#id": "ContainerGroups_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A container group part of the list result.",
            "old": "A container group."
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 (updated)
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 ¶

⚶ Changes

{
  "#id": "ContainerGroups_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A container group part of the list result.",
            "old": "A container group."
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
]
,
}
,
}