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

2025/09/26 • 35 new, 35 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: 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 (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: 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 ,
]
,
}
,
}
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: The API version to use for this operation. ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: 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 ,
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: 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 ,
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: 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 ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: 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 ,
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 ,
]
,
}
,
}
NGroups_Get (new)
Description :  Get the properties of the specified NGroups resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
]
,
}
,
}
NGroups_CreateOrUpdate (new)
Description :  Create or update a NGroups resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Update (new)
Description :  Update a specified NGroups resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
zones:
{
Description: The zones for the NGroup. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Delete (new)
Description :  Deletes the NGroups resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Start (new)
Description :  Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/start
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Stop (new)
Description :  Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/stop
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
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 ,
]
,
}
,
}
NGroups_Restart (new)
Description :  Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/restart
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_ListByResourceGroup (new)
Description :  Gets a list of all NGroups resources under a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
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 ,
]
,
}
,
}
NGroups_List (new)
Description :  Gets a list of all NGroups resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/ngroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
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 ,
]
,
}
,
}
CGProfiles_ListBySubscription (new)
Description :  Gets a list of all container group profiles under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroupProfiles
{
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 ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfiles_ListByResourceGroup (new)
Description :  Gets a list of all container group profiles under a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfile_CreateOrUpdate (new)
Description :  Create a CGProfile if it doesn't exist or update an existing CGProfile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
ContainerGroupProfile:
{
Description: The ContainerGroupProfile object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_Update (new)
Description :  Update a specified container group profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
properties:
{
Description: The container group profile properties that need to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_Get (new)
Description :  Get the properties of the specified container group profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
]
,
}
,
}
CGProfile_Delete (new)
Description :  Deletes a container group profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_ListAllRevisions (new)
Description :  Get a list of all the revisions of the specified container group profile in the given subscription and resource group. This operation returns properties of each revision of the specified container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, revision number, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfile_GetByRevisionNumber (new)
Description :  Gets the properties of the specified revision of the container group profile in the given subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions/{revisionNumber}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
revisionNumber:
{
Description: The revision number of the container group profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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: 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 (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: 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 ,
]
,
}
,
}
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: 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 ,
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: The API version to use for this operation. ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: 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 ,
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: 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 ,
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: 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 ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: 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 ,
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 ,
]
,
}
,
}
NGroups_Get (removed)
Description :  Get the properties of the specified NGroups resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
]
,
}
,
}
NGroups_CreateOrUpdate (removed)
Description :  Create or update a NGroups resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Update (removed)
Description :  Update a specified NGroups resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
zones:
{
Description: The zones for the NGroup. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Delete (removed)
Description :  Deletes the NGroups resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Start (removed)
Description :  Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/start
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Stop (removed)
Description :  Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/stop
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
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 ,
]
,
}
,
}
NGroups_Restart (removed)
Description :  Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/restart
{
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 ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_ListByResourceGroup (removed)
Description :  Gets a list of all NGroups resources under a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
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 ,
]
,
}
,
}
NGroups_List (removed)
Description :  Gets a list of all NGroups resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/ngroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. ,
Required: False ,
}
{
faultDomainCount:
{
Description: The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
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 ,
]
,
}
,
}
CGProfiles_ListBySubscription (removed)
Description :  Gets a list of all container group profiles under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroupProfiles
{
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 ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfiles_ListByResourceGroup (removed)
Description :  Gets a list of all container group profiles under a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfile_CreateOrUpdate (removed)
Description :  Create a CGProfile if it doesn't exist or update an existing CGProfile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
ContainerGroupProfile:
{
Description: The ContainerGroupProfile object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_Update (removed)
Description :  Update a specified container group profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
properties:
{
Description: The container group profile properties that need to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
Description: A container group profile object ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_Get (removed)
Description :  Get the properties of the specified container group profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
]
,
}
,
}
CGProfile_Delete (removed)
Description :  Deletes a container group profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CGProfile_ListAllRevisions (removed)
Description :  Get a list of all the revisions of the specified container group profile in the given subscription and resource group. This operation returns properties of each revision of the specified container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, revision number, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of ContainerGroupProfiles under a subscription or resource group. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Container Group Profiles. ,
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 ,
]
,
}
,
}
CGProfile_GetByRevisionNumber (removed)
Description :  Gets the properties of the specified revision of the container group profile in the given subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions/{revisionNumber}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerGroupProfileName:
{
Description: ContainerGroupProfile name. ,
Required: True ,
}
string ,
revisionNumber:
{
Description: The revision number of the container group profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The container group profile properties ,
Required: False ,
}
{
sku:
{
Description: The SKU for a container group. ,
Enum:
{
NotSpecified: No description available. ,
Standard: No description available. ,
Dedicated: No description available. ,
Confidential: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProperties:
{
Description: The encryption properties for a container group. ,
Required: False ,
}
{
vaultBaseUrl:
{
Description: The keyvault base url. ,
Required: True ,
}
string ,
keyName:
{
Description: The encryption key name. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The encryption key version. ,
Required: True ,
}
string ,
identity:
{
Description: The keyvault managed identity. ,
Required: False ,
}
string ,
}
,
containers:
{
Description: The containers within the container group. ,
Required: True ,
}
[
{
name:
{
Description: The user-provided name of the container instance. ,
Required: True ,
}
string ,
properties:
{
Description: The properties of the container instance. ,
Required: True ,
}
{
image:
{
Description: The name of the image used to create the container instance. ,
Required: False ,
}
string ,
command:
{
Description: The commands to execute within the container instance in exec form. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The exposed ports on the container instance. ,
Required: False ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number exposed within the container group. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
environmentVariables:
{
Description: The environment variables to set in the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the container instance. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the container instance has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: Current container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: Previous container instance state. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the container instance. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resources:
{
Description: The resource requirements of the container instance. ,
Required: False ,
}
{
requests:
{
Description: The resource requests of this container instance. ,
Required: True ,
}
{
memoryInGB:
{
Description: The memory request in GB of this container instance. ,
Format: double ,
Required: True ,
}
number ,
cpu:
{
Description: The CPU request of this container instance. ,
Format: double ,
Required: True ,
}
number ,
gpu:
{
Description: The GPU request of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
limits:
{
Description: The resource limits of this container instance. ,
Required: False ,
}
{
memoryInGB:
{
Description: The memory limit in GB of this container instance. ,
Format: double ,
Required: False ,
}
number ,
cpu:
{
Description: The CPU limit of this container instance. ,
Format: double ,
Required: False ,
}
number ,
gpu:
{
Description: The GPU limit of this container instance. ,
Required: False ,
}
{
count:
{
Description: The count of the GPU resource. ,
Format: int32 ,
Required: True ,
}
integer ,
sku:
{
Description: The SKU of the GPU resource. ,
Enum:
{
K80: No description available. ,
P100: No description available. ,
V100: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
volumeMounts:
{
Description: The volume mounts available to the container instance. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
livenessProbe:
{
Description: The liveness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readinessProbe:
{
Description: The readiness probe. ,
Required: False ,
}
{
exec:
{
Description: The execution command to probe ,
Required: False ,
}
{
command:
{
Description: The commands to execute within the container. ,
Required: False ,
}
[
string ,
]
,
}
,
httpGet:
{
Description: The Http Get settings to probe ,
Required: False ,
}
{
path:
{
Description: The path to probe. ,
Required: False ,
}
string ,
port:
{
Description: The port number to probe. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: The scheme. ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
httpHeaders:
{
Description: The HTTP headers. ,
Required: False ,
}
[
{
name:
{
Description: The header name. ,
Required: False ,
}
string ,
value:
{
Description: The header value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
initialDelaySeconds:
{
Description: The initial delay seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: The period seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
failureThreshold:
{
Description: The failure threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
Description: The success threshold. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
configMap:
{
Description: The config map. ,
Required: False ,
}
{
keyValuePairs:
{
Description: The key value pairs dictionary in the config map. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
initContainers:
{
Description: The init containers for a container group. ,
Required: False ,
}
[
{
name:
{
Description: The name for the init container. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for the init container. ,
Required: True ,
}
{
image:
{
Description: The image of the init container. ,
Required: False ,
}
string ,
command:
{
Description: The command to execute within the init container in exec form. ,
Required: False ,
}
[
string ,
]
,
environmentVariables:
{
Description: The environment variables to set in the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
secureValue:
{
Description: The value of the secure environment variable. ,
Required: False ,
}
string ,
secureValueReference:
{
Description: The reference of the secure environment variable. ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The instance view of the init container. Only valid in response. ,
Required: False ,
}
{
restartCount:
{
Description: The number of times that the init container has been restarted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentState:
{
Description: The current state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
previousState:
{
Description: The previous state of the init container. ,
Required: False ,
}
{
state:
{
Description: The state of the container instance. ,
Required: False ,
}
string ,
startTime:
{
Description: The date-time when the container instance state started. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: The container instance exit codes correspond to those from the `docker run` command. ,
Format: int32 ,
Required: False ,
}
integer ,
finishTime:
{
Description: The date-time when the container instance state finished. ,
Format: date-time ,
Required: False ,
}
string ,
detailStatus:
{
Description: The human-readable status of the container instance state. ,
Required: False ,
}
string ,
}
,
events:
{
Description: The events of the init container. ,
Required: False ,
}
[
{
count:
{
Description: The count of the event. ,
Format: int32 ,
Required: False ,
}
integer ,
firstTimestamp:
{
Description: The date-time of the earliest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimestamp:
{
Description: The date-time of the latest logged event. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The event name. ,
Required: False ,
}
string ,
message:
{
Description: The event message. ,
Required: False ,
}
string ,
type:
{
Description: The event type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
volumeMounts:
{
Description: The volume mounts available to the init container. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
extensions:
{
Description: extensions used by virtual kubelet ,
Required: False ,
}
[
{
name:
{
Description: Name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Extension specific properties ,
Required: False ,
}
{
extensionType:
{
Description: Type of extension to be added. ,
Required: True ,
}
string ,
version:
{
Description: Version of the extension being used. ,
Required: True ,
}
string ,
settings:
{
Description: Settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension. ,
Required: False ,
}
object ,
}
,
}
,
]
,
imageRegistryCredentials:
{
Description: The image registry credentials by which the container group is created from. ,
Required: False ,
}
[
{
server:
{
Description: The Docker image registry server without a protocol such as "http" and "https". ,
Required: True ,
}
string ,
username:
{
Description: The username for the private registry. ,
Required: False ,
}
string ,
password:
{
Description: The password for the private registry. ,
Required: False ,
}
string ,
passwordReference:
{
Description: The reference for the private registry password. ,
Required: False ,
}
string ,
identity:
{
Description: The identity for the private registry. ,
Required: False ,
}
string ,
identityUrl:
{
Description: The identity URL for the private registry. ,
Required: False ,
}
string ,
}
,
]
,
restartPolicy:
{
Description: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart ,
Enum:
{
Always: No description available. ,
OnFailure: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
shutdownGracePeriod:
{
Description: Shutdown grace period for containers in a container group. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The IP address type of the container group. ,
Required: False ,
}
{
ports:
{
Description: The list of ports exposed on the container group. ,
Required: True ,
}
[
{
protocol:
{
Description: The protocol associated with the port. ,
Enum:
{
TCP: No description available. ,
UDP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The port number. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
type:
{
Description: Specifies if the IP is exposed to the public internet or private VNET. ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: True ,
}
enum ,
ip:
{
Description: The IP exposed to the public internet. ,
Required: False ,
}
string ,
dnsNameLabel:
{
Description: The Dns name label for the IP. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
Noreuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The FQDN for the IP. ,
Required: False ,
}
string ,
}
,
timeToLive:
{
Description: Post completion time to live for containers of a CG ,
Format: date-time ,
Required: False ,
}
string ,
osType:
{
Description: The operating system type required by the containers in the container group. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
volumes:
{
Description: The list of volumes that can be mounted by containers in this container group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
emptyDir:
{
Description: The empty directory volume. ,
Required: False ,
}
object ,
secret:
{
Description: The secret volume. ,
Required: False ,
}
object ,
secretReference:
{
Description: The secret reference volume. ,
Required: False ,
}
object ,
gitRepo:
{
Description: The git repo volume. ,
Required: False ,
}
{
directory:
{
Description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. ,
Required: False ,
}
string ,
repository:
{
Description: Repository URL ,
Required: True ,
}
string ,
revision:
{
Description: Commit hash for the specified revision. ,
Required: False ,
}
string ,
}
,
}
,
]
,
diagnostics:
{
Description: The diagnostic information for a container group. ,
Required: False ,
}
{
logAnalytics:
{
Description: Container group log analytics information. ,
Required: False ,
}
{
workspaceId:
{
Description: The workspace id for log analytics ,
Required: True ,
}
string ,
workspaceKey:
{
Description: The workspace key for log analytics ,
Required: True ,
}
string ,
logType:
{
Description: The log type to be used. ,
Enum:
{
ContainerInsights: No description available. ,
ContainerInstanceLogs: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Metadata for log analytics. ,
Required: False ,
}
object ,
workspaceResourceId:
{
Description: The workspace resource id for log analytics ,
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: The priority of the container group. ,
Enum:
{
Regular: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
confidentialComputeProperties:
{
Description: The properties for confidential container group ,
Required: False ,
}
{
ccePolicy:
{
Description: The base64 encoded confidential compute enforcement policy ,
Required: False ,
}
string ,
}
,
securityContext:
{
Description: The container security properties. ,
Required: False ,
}
{
privileged:
{
Description: The flag to determine if the container permissions is elevated to Privileged. ,
Required: False ,
}
boolean ,
allowPrivilegeEscalation:
{
Description: A boolean value indicating whether the init process can elevate its privileges ,
Required: False ,
}
boolean ,
capabilities:
{
Description: The capabilities to add or drop from a container. ,
Required: False ,
}
{
add:
{
Description: The capabilities to add to the container. ,
Required: False ,
}
[
string ,
]
,
drop:
{
Description: The capabilities to drop from the container. ,
Required: False ,
}
[
string ,
]
,
}
,
runAsGroup:
{
Description: Sets the User GID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsUser:
{
Description: Sets the User UID for the container. ,
Format: int32 ,
Required: False ,
}
integer ,
seccompProfile:
{
Description: a base64 encoded string containing the contents of the JSON in the seccomp profile ,
Required: False ,
}
string ,
}
,
revision:
{
Description: Container group profile current revision number ,
Format: int32 ,
Required: False ,
}
integer ,
registeredRevisions:
{
Description: Registered revisions are calculated at request time based off the records in the table logs. ,
Required: False ,
}
[
integer ,
]
,
useKrypton:
{
Description: Gets or sets Krypton use property. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
]
,
}
,
}