Azure Container Instance

Easily run containers on Azure with a single command. Create container groups, get the logs of a container and more.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions
Power Automate	Premium	All Power Automate regions
Power Apps	Premium	All Power Apps regions

Contact
Name	Microsoft
URL	Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support

Connector Metadata
Publisher	Microsoft
Website	https://azure.microsoft.com/services/container-instances/

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Attach to the output of a specific container instance	Attach to the output stream of a specific container instance in a specified resource group and container group.
Create or update a container group	Create or update a container group with specified configurations.
Delete a container group	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.
Delete container group virtual network association links	Delete container group virtual network association links. The operation does not delete other resources provided by the user.
Executes a command in a specific container instance	Executes a command for a specific container instance in a specified resource group and container group.
Get a list of container groups in a resource group	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.
Get a list of container groups in a subscription	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.
Get all network dependencies for container group	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.
Get cached images	Get the list of cached images on specific OS type for a subscription in a region.
Get capabilities	Get the list of CPU/memory/GPU capabilities for a subscription in a region.
Get current usage	Get the usage for a subscription
Get logs from a container instance	Get the logs for a specified container instance in a specified resource group and container group.
Get properties of a container group	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.
Restart containers in a container group	Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
Start containers in a container group	Starts all containers in a container group. Compute resources will be allocated and billing will start.
Stop containers in a container group	Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
Update a container group location or tags	Update a container group with the specified tags and/or location.

Attach to the output of a specific container instance

Operation ID:

Containers_Attach

Attach to the output stream of a specific container instance in a specified resource group and container group.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.
containerName	containerName	True	string	The name of the container instance.

Returns

The information for the output stream from container attach.

Body

ContainerAttachResponse

Create or update a container group

Operation ID:

ContainerGroups_CreateOrUpdate

Create or update a container group with specified configurations.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.
id	id		string	The resource id.
name	name		string	The resource name.
type	type		string	The resource type.
Location	location	True	string	The resource location.
Tags	tags		object	The resource tags.
Zone	zones		array of string	The zones for the container group.
principalId	principalId		string	The principal id of the container group identity. This property will only be provided for a system assigned identity.
tenantId	tenantId		string	The tenant id associated with the container group. This property will only be provided for a system assigned identity.
Type	type		string	The type of identity used for the container group. 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 container group.
User Assigned Identities	userAssignedIdentities		object	The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
provisioningState	provisioningState		string	The provisioning state of the container group. This only appears in the response.
Name	name	True	string	The name of the container.
Image	image	True	string	The name of the image used to create the container. E.g. nginx:latest
Command	command		array of string	The commands to execute within the container. E.g. [ "echo", "hello aci" ]
Protocol	protocol		string	The protocol associated with the port.
Number	port	True	integer	The port number exposed within the container group.
Name	name	True	string	The name of the environment variable.
Value	value		string	The value of the environment variable.
secureValue	secureValue		string	The value of the secure environment variable.
restartCount	restartCount		integer	The number of times that the container instance has been restarted.
state	state		string	The state of the container instance.
startTime	startTime		date-time	The date-time when the container instance state started.
exitCode	exitCode		integer	The container instance exit codes correspond to those from the docker run command.
finishTime	finishTime		date-time	The date-time when the container instance state finished.
detailStatus	detailStatus		string	The human-readable status of the container instance state.
count	count		integer	The count of the event.
firstTimestamp	firstTimestamp		date-time	The date-time of the earliest logged event.
lastTimestamp	lastTimestamp		date-time	The date-time of the latest logged event.
name	name		string	The event name.
message	message		string	The event message.
type	type		string	The event type.
Memory	memoryInGB	True	number	The memory request in GB of this container. E.g. 3.5
CPU	cpu	True	number	The CPU request of this container. E.g. 2.0
Count	count		integer	The count of the GPU resource.
SKU	sku		string	The SKU of the GPU resource.
Memory	memoryInGB		double	The memory limit in GB of this container.
CPU	cpu		double	The CPU limit of this container.
Name	name	True	string	The name of the volume.
Path	mountPath	True	string	The path within the container where the volume should be mounted. Must not contain colon (:).
Readonly	readOnly		boolean	The flag indicating whether the volume mount is read-only.
Command	command		array of string	The commands to execute within the container.
Path	path		string	The path to probe.
Port	port		integer	The port number to probe.
Scheme	scheme		string	The scheme.
name	name		string	The header name.
value	value		string	The header value.
Initial Delay	initialDelaySeconds		integer	The initial delay seconds.
Period	periodSeconds		integer	The period seconds.
Failure Threshold	failureThreshold		integer	The failure threshold.
Success Threshold	successThreshold		integer	The success threshold.
Timeout	timeoutSeconds		integer	The timeout seconds.
privileged	privileged		boolean	The flag to determine if the container permissions is elevated to Privileged.
allowPrivilegeEscalation	allowPrivilegeEscalation		boolean	A boolean value indicating whether the init process can elevate its privileges
add	add		array of string	The capabilities to add to the container.
drop	drop		array of string	The capabilities to drop from the container.
runAsGroup	runAsGroup		integer	Sets the User GID for the container.
runAsUser	runAsUser		integer	Sets the User UID for the container.
seccompProfile	seccompProfile		string	a base64 encoded string containing the contents of the JSON in the seccomp profile
Server	server	True	string	The Docker image registry server without a protocol such as "myacr.azurecr.io".
User Name	username		string	The username for the private registry.
Password	password		string	The password for the private registry.
Identity	identity		string	The identity for the private registry.
IdentityURL	identityUrl		string	The identity URL for the private registry.
restartPolicy	restartPolicy		string	Restart policy for all containers within the container group. Always Always restart OnFailure Restart on failure Never Never restart
Protocol	protocol		string	The protocol associated with the port.
Number	port	True	integer	The port number.
Type	type	True	string	Specifies if the IP is exposed to the public internet.
ip	ip		string	The IP exposed to the public internet.
Dns Name	dnsNameLabel		string	The Dns name label for the IP.
autoGeneratedDomainNameLabelScope	autoGeneratedDomainNameLabelScope		string	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.
fqdn	fqdn		string	The FQDN for the IP.
osType	osType	True	string	The operating system type required by the containers in the container group.
Name	name	True	string	The name of the volume.
Share Name	shareName	True	string	The name of the Azure File share to be mounted as a volume.
ReadOnly	readOnly		boolean	The flag indicating whether the Azure File shared mounted as a volume is read-only.
Storage Account Name	storageAccountName	True	string	The name of the storage account that contains the Azure File share.
Storage Account Key	storageAccountKey		string	The storage account access key used to access the Azure File share.
Secret Volume	secret		object	The secret volume.
Directory	directory		string	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.
Repository	repository	True	string	Repository URL
Revision	revision		string	Commit hash for the specified revision.
state	state		string	The state of the container group. Only valid in response.
Workspace Id	workspaceId	True	string	The workspace id for log analytics
Workspace Key	workspaceKey	True	string	The workspace key for log analytics
Log Type	logType		string	The log type to be used.
Metadata	metadata		object	Metadata for log analytics.
workspaceResourceId	workspaceResourceId		string	The workspace resource id for log analytics
id	id	True	string	Resource ID of virtual network and subnet.
name	name		string	Friendly name for the subnet.
Name Servers	nameServers	True	array of string	The DNS servers for the container group.
Search Domains	searchDomains		string	The DNS search domains for hostname lookup in the container group.
Options	options		string	The DNS options for the container group.
SKU	sku		string	The container group SKU.
Vault Url	vaultBaseUrl	True	string	The keyvault base url.
Key Name	keyName	True	string	The encryption key name.
Key Version	keyVersion	True	string	The encryption key version.
Identity	identity		string	The keyvault managed identity.
Name	name	True	string	The name for the init container.
Image	image		string	The image of the init container.
Command	command		array of string	The command to execute within the init container in exec form.
restartCount	restartCount		integer	The number of times that the init container has been restarted.
name	name	True	string	Name of the extension.
extensionType	extensionType	True	string	Type of extension to be added.
version	version	True	string	Version of the extension being used.
settings	settings		object	Settings for the extension.
protectedSettings	protectedSettings		object	Protected settings for the extension.
ccePolicy	ccePolicy		string	The base64 encoded confidential compute enforcement policy
priority	priority		string	The priority of the container group.

Returns

A container group.

ContainerGroup

ContainerGroup

Delete a container group

Operation ID:

ContainerGroups_Delete

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.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Returns

A container group.

ContainerGroup

ContainerGroup

Delete container group virtual network association links

Operation ID:

SubnetServiceAssociationLink_Delete

Delete container group virtual network association links. The operation does not delete other resources provided by the user.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Virtual Network Name	virtualNetworkName	True	string	The name of the virtual network.
Subnet Name	subnetName	True	string	The name of the subnet.

Executes a command in a specific container instance

Operation ID:

Containers_ExecuteCommand

Executes a command for a specific container instance in a specified resource group and container group.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.
containerName	containerName	True	string	The name of the container instance.
command	command		string	The command to be executed.
rows	rows		integer	The row size of the terminal
cols	cols		integer	The column size of the terminal

Returns

The information for the container exec command.

Body

ContainerExecResponse

Get a list of container groups in a resource group

Operation ID:

ContainerGroups_ListByResourceGroup

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.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.

Returns

The container group list response that contains the container group properties.

Body

ContainerGroupListResult

Get a list of container groups in a subscription

Operation ID:

ContainerGroups_List

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.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns

The container group list response that contains the container group properties.

Body

ContainerGroupListResult

Get all network dependencies for container group

Operation ID:

ContainerGroups_GetOutboundNetworkDependenciesEndpoints

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.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Returns

Response for network dependencies, always empty list.

Items

NetworkDependenciesResponse

Get cached images

Operation ID:

Location_ListCachedImages

Get the list of cached images on specific OS type for a subscription in a region.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Location	location	True	string	The identifier for the physical azure location.

Returns

The response containing cached images.

Body

CachedImagesListResult

Get capabilities

Operation ID:

Location_ListCapabilities

Get the list of CPU/memory/GPU capabilities for a subscription in a region.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Location	location	True	string	The identifier for the physical azure location.

Returns

The response containing list of capabilities.

Body

CapabilitiesListResult

Get current usage

Operation ID:

Location_ListUsage

Get the usage for a subscription

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Location	location	True	string	The identifier for the physical azure location.

Returns

The response containing the usage data

Body

UsageListResult

Get logs from a container instance

Operation ID:

ContainerLogs_List

Get the logs for a specified container instance in a specified resource group and container group.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.
Container Name	containerName	True	string	The name of the container instance.
Tail Lines	tail		integer	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.

Returns

The logs.

Body

Logs

Get properties of a container group

Operation ID:

ContainerGroups_Get

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.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Returns

A container group.

ContainerGroup

ContainerGroup

Restart containers in a container group

Operation ID:

ContainerGroups_Restart

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Start containers in a container group

Operation ID:

ContainerGroups_Start

Starts all containers in a container group. Compute resources will be allocated and billing will start.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Stop containers in a container group

Operation ID:

ContainerGroups_Stop

Stops all containers in a container group. Compute resources will be deallocated and billing will stop.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.

Update a container group location or tags

Operation ID:

ContainerGroups_Update

Update a container group with the specified tags and/or location.

Parameters

Name	Key	Required	Type	Description
Subscription Id	subscriptionId	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Resource Group	resourceGroupName	True	string	The name of the resource group.
Container Group Name	containerGroupName	True	string	The name of the container group.
id	id		string	The resource id.
name	name		string	The resource name.
type	type		string	The resource type.
Location	location		string	The resource location.
Tags	tags		object	The resource tags.
zones	zones		array of string	The zones for the container group.

Returns

A container group.

ContainerGroup

ContainerGroup

Definitions

Container

A container instance.

Name	Path	Type	Description
Name	name	string	The name of the container.
properties	properties	ContainerProperties	The container properties.

ContainerProperties

The container properties.

Name	Path	Type	Description
Image	image	string	The name of the image used to create the container. E.g. nginx:latest
Command	command	array of string	The commands to execute within the container. E.g. [ "echo", "hello aci" ]
Ports	ports	array of ContainerPort	The exposed ports on the container instance.
Environment Variables	environmentVariables	array of EnvironmentVariable	The environment variables to set in the container instance.
restartCount	instanceView.restartCount	integer	The number of times that the container instance has been restarted.
currentState	instanceView.currentState	ContainerState	The container instance state.
previousState	instanceView.previousState	ContainerState	The container instance state.
events	instanceView.events	array of Event	The events of the container instance.
resources	resources	ResourceRequirements	The resource requirements.
Volume Mounts	volumeMounts	array of VolumeMount	The volume mounts available to the container instance.
Liveness Probe	livenessProbe	ContainerProbe	The container probe, for liveness
Liveness Probe	readinessProbe	ContainerProbe	The container probe, for liveness
securityContext	securityContext	SecurityContextDefinition	The security context for the container.

SecurityContextDefinition

The security context for the container.

Name	Path	Type	Description
privileged	privileged	boolean	The flag to determine if the container permissions is elevated to Privileged.
allowPrivilegeEscalation	allowPrivilegeEscalation	boolean	A boolean value indicating whether the init process can elevate its privileges
capabilities	capabilities	SecurityContextCapabilitiesDefinition	The capabilities to add or drop from a container.
runAsGroup	runAsGroup	integer	Sets the User GID for the container.
runAsUser	runAsUser	integer	Sets the User UID for the container.
seccompProfile	seccompProfile	string	a base64 encoded string containing the contents of the JSON in the seccomp profile

SecurityContextCapabilitiesDefinition

The capabilities to add or drop from a container.

Name	Path	Type	Description
add	add	array of string	The capabilities to add to the container.
drop	drop	array of string	The capabilities to drop from the container.

ContainerState

The container instance state.

Name	Path	Type	Description
state	state	string	The state of the container instance.
startTime	startTime	date-time	The date-time when the container instance state started.
exitCode	exitCode	integer	The container instance exit codes correspond to those from the docker run command.
finishTime	finishTime	date-time	The date-time when the container instance state finished.
detailStatus	detailStatus	string	The human-readable status of the container instance state.

Event

A container group or container instance event.

Name	Path	Type	Description
count	count	integer	The count of the event.
firstTimestamp	firstTimestamp	date-time	The date-time of the earliest logged event.
lastTimestamp	lastTimestamp	date-time	The date-time of the latest logged event.
name	name	string	The event name.
message	message	string	The event message.
type	type	string	The event type.

ResourceRequirements

The resource requirements.

Name	Path	Type	Description
Resource Requests	requests	ResourceRequests	The resource requests.
Resource Limits	limits	ResourceLimits	The resource limits.

ResourceRequests

The resource requests.

Name	Path	Type	Description
Memory	memoryInGB	number	The memory request in GB of this container. E.g. 3.5
CPU	cpu	number	The CPU request of this container. E.g. 2.0
GPU	gpu	GpuResource	The GPU resource.

ResourceLimits

The resource limits.

Name	Path	Type	Description
Memory	memoryInGB	double	The memory limit in GB of this container.
CPU	cpu	double	The CPU limit of this container.
GPU	gpu	GpuResource	The GPU resource.

GpuResource

The GPU resource.

Name	Path	Type	Description
Count	count	integer	The count of the GPU resource.
SKU	sku	string	The SKU of the GPU resource.

AzureFileVolume

The properties of the Azure File volume. Azure File shares are mounted as volumes.

Name	Path	Type	Description
Share Name	shareName	string	The name of the Azure File share to be mounted as a volume.
ReadOnly	readOnly	boolean	The flag indicating whether the Azure File shared mounted as a volume is read-only.
Storage Account Name	storageAccountName	string	The name of the storage account that contains the Azure File share.
Storage Account Key	storageAccountKey	string	The storage account access key used to access the Azure File share.

EmptyDirVolume

The empty directory volume.

SecretVolume

The secret volume.

Name	Path	Type	Description
Secret Volume		object	The secret volume.

GitRepoVolume

Represents a volume that is populated with the contents of a git repository

Name	Path	Type	Description
Directory	directory	string	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.
Repository	repository	string	Repository URL
Revision	revision	string	Commit hash for the specified revision.

Volume

The properties of the volume.

Name	Path	Type	Description
Name	name	string	The name of the volume.
Azure File Volume	azureFile	AzureFileVolume	The properties of the Azure File volume. Azure File shares are mounted as volumes.
Empty Directory Volume	emptyDir	EmptyDirVolume	The empty directory volume.
Secret Volume	secret	SecretVolume	The secret volume.
Git Repo Volume	gitRepo	GitRepoVolume	Represents a volume that is populated with the contents of a git repository

VolumeMount

The properties of the volume mount.

Name	Path	Type	Description
Name	name	string	The name of the volume.
Path	mountPath	string	The path within the container where the volume should be mounted. Must not contain colon (:).
Readonly	readOnly	boolean	The flag indicating whether the volume mount is read-only.

ContainerExec

The container execution command, for liveness or readiness probe

Name	Path	Type	Description
Command	command	array of string	The commands to execute within the container.

ContainerHttpGet

The container Http Get settings, for liveness or readiness probe

Name	Path	Type	Description
Path	path	string	The path to probe.
Port	port	integer	The port number to probe.
Scheme	scheme	string	The scheme.
httpHeaders	httpHeaders	array of HttpHeader	The HTTP headers.

ContainerProbe

The container probe, for liveness

Name	Path	Type	Description
Exec	exec	ContainerExec	The container execution command, for liveness or readiness probe
HTTP GET	httpGet	ContainerHttpGet	The container Http Get settings, for liveness or readiness probe
Initial Delay	initialDelaySeconds	integer	The initial delay seconds.
Period	periodSeconds	integer	The period seconds.
Failure Threshold	failureThreshold	integer	The failure threshold.
Success Threshold	successThreshold	integer	The success threshold.
Timeout	timeoutSeconds	integer	The timeout seconds.

ContainerGroup

A container group.

Name	Path	Type	Description
id	id	string	The resource id.
name	name	string	The resource name.
type	type	string	The resource type.
Location	location	string	The resource location.
Tags	tags	object	The resource tags.
Zone	zones	array of string	The zones for the container group.
Managed Identity	identity	ContainerGroupIdentity	Identity for the container group.
properties	properties	ContainerGroupProperties	The container group properties

ContainerGroupProperties

The container group properties

Name	Path	Type	Description
provisioningState	provisioningState	string	The provisioning state of the container group. This only appears in the response.
containers	containers	array of Container	The containers within the container group.
imageRegistryCredentials	imageRegistryCredentials	array of ImageRegistryCredential	The image registry credentials by which the container group is created from.
restartPolicy	restartPolicy	string	Restart policy for all containers within the container group. Always Always restart OnFailure Restart on failure Never Never restart
IP Address	ipAddress	IpAddress	IP address for the container group.
osType	osType	string	The operating system type required by the containers in the container group.
volumes	volumes	array of Volume	The list of volumes that can be mounted by containers in this container group.
events	instanceView.events	array of Event	The events of this container group.
state	instanceView.state	string	The state of the container group. Only valid in response.
diagnostics	diagnostics	ContainerGroupDiagnostics	Container group diagnostic information.
subnetIds	subnetIds	array of ContainerGroupSubnetId	The subnet resource IDs for a container group.
DNS Configuration	dnsConfig	DnsConfiguration	DNS configuration for the container group.
SKU	sku	ContainerGroupSku	The container group SKU.
Encryption	encryptionProperties	EncryptionProperties	The container group encryption properties.
initContainers	initContainers	array of InitContainerDefinition	The init containers for a container group.
extensions	extensions	array of DeploymentExtensionSpec	extensions used by virtual kubelet
confidentialComputeProperties	confidentialComputeProperties	ConfidentialComputeProperties	The properties for confidential container group
priority	priority	string	The priority of the container group.

DeploymentExtensionSpec

Extension sidecars to be added to the deployment.

Name	Path	Type	Description
name	name	string	Name of the extension.
extensionType	properties.extensionType	string	Type of extension to be added.
version	properties.version	string	Version of the extension being used.
settings	properties.settings	object	Settings for the extension.
protectedSettings	properties.protectedSettings	object	Protected settings for the extension.

ContainerGroupIdentity

Identity for the container group.

Name	Path	Type	Description
principalId	principalId	string	The principal id of the container group identity. This property will only be provided for a system assigned identity.
tenantId	tenantId	string	The tenant id associated with the container group. This property will only be provided for a system assigned identity.
Type	type	string	The type of identity used for the container group. 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 container group.
User Assigned Identities	userAssignedIdentities	object	The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ImageRegistryCredential

Image registry credential.

Name	Path	Type	Description
Server	server	string	The Docker image registry server without a protocol such as "myacr.azurecr.io".
User Name	username	string	The username for the private registry.
Password	password	string	The password for the private registry.
Identity	identity	string	The identity for the private registry.
IdentityURL	identityUrl	string	The identity URL for the private registry.

ContainerGroupDiagnostics

Container group diagnostic information.

Name	Path	Type	Description
Log Analytics	logAnalytics	LogAnalytics	Container group log analytics information.

LogAnalytics

Container group log analytics information.

Name	Path	Type	Description
Workspace Id	workspaceId	string	The workspace id for log analytics
Workspace Key	workspaceKey	string	The workspace key for log analytics
Log Type	logType	string	The log type to be used.
Metadata	metadata	object	Metadata for log analytics.
workspaceResourceId	workspaceResourceId	string	The workspace resource id for log analytics

ContainerGroupSubnetId

Container group subnet information.

Name	Path	Type	Description
id	id	string	Resource ID of virtual network and subnet.
name	name	string	Friendly name for the subnet.

IpAddress

IP address for the container group.

Name	Path	Type	Description
Ports	ports	array of Port	The list of ports exposed on the container group.
Type	type	string	Specifies if the IP is exposed to the public internet.
ip	ip	string	The IP exposed to the public internet.
Dns Name	dnsNameLabel	string	The Dns name label for the IP.
autoGeneratedDomainNameLabelScope	autoGeneratedDomainNameLabelScope	string	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.
fqdn	fqdn	string	The FQDN for the IP.

Port

The port exposed on the container group.

Name	Path	Type	Description
Protocol	protocol	string	The protocol associated with the port.
Number	port	integer	The port number.

ContainerPort

The port exposed on the container instance.

Name	Path	Type	Description
Protocol	protocol	string	The protocol associated with the port.
Number	port	integer	The port number exposed within the container group.

EnvironmentVariable

The environment variable to set within the container instance.

Name	Path	Type	Description
Name	name	string	The name of the environment variable.
Value	value	string	The value of the environment variable.
secureValue	secureValue	string	The value of the secure environment variable.

UsageListResult

The response containing the usage data

Name	Path	Type	Description
value	value	array of Usage	The usage data.

Usage

A single usage result

Name	Path	Type	Description
id	id	string	Id of the usage result
unit	unit	string	Unit of the usage result
currentValue	currentValue	integer	The current usage of the resource
limit	limit	integer	The maximum permitted usage of the resource.
value	name.value	string	The name of the resource
localizedValue	name.localizedValue	string	The localized name of the resource

ContainerGroupListResult

The container group list response that contains the container group properties.

Name	Path	Type	Description
value	value	array of ContainerGroup	The list of container groups.
nextLink	nextLink	string	The URI to fetch the next page of container groups.

Logs

The logs.

Name	Path	Type	Description
content	content	string	The content of the log.

ContainerExecResponse

The information for the container exec command.

Name	Path	Type	Description
webSocketUri	webSocketUri	string	The uri for the exec websocket.
password	password	string	The password to start the exec command.

ContainerAttachResponse

The information for the output stream from container attach.

Name	Path	Type	Description
webSocketUri	webSocketUri	string	The uri for the output stream from the attach.
password	password	string	The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.

HttpHeader

The HTTP header.

Name	Path	Type	Description
name	name	string	The header name.
value	value	string	The header value.

DnsConfiguration

DNS configuration for the container group.

Name	Path	Type	Description
Name Servers	nameServers	array of string	The DNS servers for the container group.
Search Domains	searchDomains	string	The DNS search domains for hostname lookup in the container group.
Options	options	string	The DNS options for the container group.

CachedImagesListResult

The response containing cached images.

Name	Path	Type	Description
value	value	array of cachedImages	The list of cached images.
nextLink	nextLink	string	The URI to fetch the next page of cached images.

cachedImages

The cached image and OS type.

Name	Path	Type	Description
osType	osType	string	The OS type of the cached image.
image	image	string	The cached image name.

CapabilitiesListResult

The response containing list of capabilities.

Name	Path	Type	Description
value	value	array of Capabilities	The list of capabilities.
nextLink	nextLink	string	The URI to fetch the next page of capabilities.

Capabilities

The regional capabilities.

Name	Path	Type	Description
resourceType	resourceType	string	The resource type that this capability describes.
osType	osType	string	The OS type that this capability describes.
location	location	string	The resource location.
ipAddressType	ipAddressType	string	The ip address type that this capability describes.
gpu	gpu	string	The GPU sku that this capability describes.
maxMemoryInGB	capabilities.maxMemoryInGB	number	The maximum allowed memory request in GB.
maxCpu	capabilities.maxCpu	number	The maximum allowed CPU request in cores.
maxGpuCount	capabilities.maxGpuCount	number	The maximum allowed GPU count.

ContainerGroupSku

The container group SKU.

The container group SKU.

SKU

string

EncryptionProperties

The container group encryption properties.

Name	Path	Type	Description
Vault Url	vaultBaseUrl	string	The keyvault base url.
Key Name	keyName	string	The encryption key name.
Key Version	keyVersion	string	The encryption key version.
Identity	identity	string	The keyvault managed identity.

InitContainerDefinition

The init container definition.

Name	Path	Type	Description
Name	name	string	The name for the init container.
properties	properties	InitContainerPropertiesDefinition	The init container definition properties.

InitContainerPropertiesDefinition

The init container definition properties.

Name	Path	Type	Description
Image	image	string	The image of the init container.
Command	command	array of string	The command to execute within the init container in exec form.
Environment Variables	environmentVariables	array of EnvironmentVariable	The environment variables to set in the init container.
restartCount	instanceView.restartCount	integer	The number of times that the init container has been restarted.
currentState	instanceView.currentState	ContainerState	The container instance state.
previousState	instanceView.previousState	ContainerState	The container instance state.
events	instanceView.events	array of Event	The events of the init container.
Volume Mounts	volumeMounts	array of VolumeMount	The volume mounts available to the init container.
securityContext	securityContext	SecurityContextDefinition	The security context for the container.

NetworkDependenciesResponse

Response for network dependencies, always empty list.

Name	Path	Type	Description
Items		string

ConfidentialComputeProperties

The properties for confidential container group

Name	Path	Type	Description
ccePolicy	ccePolicy	string	The base64 encoded confidential compute enforcement policy