Microsoft.ContainerInstance containerGroups 2017-08-01-preview
Article 05/10/2023
1 contributor
Feedback
In this article
Bicep resource definition
The containerGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.ContainerInstance/containerGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2017-08-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
value: 'string'
}
]
image: 'string'
ports: [
{
port: int
}
]
resources: {
limits: {
cpu: int
memoryInGB: json('decimal-as-string')
}
requests: {
cpu: int
memoryInGB: json('decimal-as-string')
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'Public'
}
osType: 'string'
restartPolicy: 'always'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
name: 'string'
}
]
}
}
Property values
containerGroups
Name
Description
Value
name
The resource name
string (required)
location
The resource location.
string (required)
tags
The resource tags.
Dictionary of tag names and values. See Tags in templates
properties
ContainerGroupProperties (required)
ContainerGroupProperties
Name
Description
Value
containers
The containers within the container group.
Container [] (required)
imageRegistryCredentials
The image registry credentials by which the container group is created from.
ImageRegistryCredential []
ipAddress
The IP address type of the container group.
IpAddress
osType
The operating system type required by the containers in the container group.
'Linux'
restartPolicy
Restart policy for all containers within the container group. Currently the only available option is always.
'always'
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (required)
ContainerProperties
Name
Description
Value
command
The commands to execute within the container instance in exec form.
string[]
environmentVariables
The environment variables to set in the container instance.
EnvironmentVariable []
image
The name of the image used to create the container instance.
string (required)
ports
The exposed ports on the container instance.
ContainerPort []
resources
The resource requirements of the container instance.
ResourceRequirements (required)
volumeMounts
The volume mounts available to the container instance.
VolumeMount []
EnvironmentVariable
Name
Description
Value
name
The name of the environment variable.
string (required)
value
The value of the environment variable.
string (required)
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
ResourceRequirements
Name
Description
Value
limits
The resource limits of this container instance.
ResourceLimits
requests
The resource requests of this container instance.
ResourceRequests (required)
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance. To specify a decimal value, use the json() function.
int or json decimal
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance. To specify a decimal value, use the json() function.
int or json decimal (required)
VolumeMount
Name
Description
Value
mountPath
The path within the container where the volume should be mounted. Must not contain colon (:).
string (required)
name
The name of the volume mount.
string (required)
readOnly
The flag indicating whether the volume mount is read-only.
bool
ImageRegistryCredential
Name
Description
Value
password
The password for the private registry.
string
server
The Docker image registry server without a protocol such as "http" and "https".
string (required)
username
The username for the private registry.
string (required)
IpAddress
Name
Description
Value
ip
The IP exposed to the public internet.
string
ports
The list of ports exposed on the container group.
Port [] (required)
type
Specifies if the IP is exposed to the public internet.
'Public' (required)
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
'TCP'
Volume
Name
Description
Value
azureFile
The name of the Azure File volume.
AzureFileVolume (required)
name
The name of the volume.
string (required)
AzureFileVolume
Name
Description
Value
readOnly
The flag indicating whether the Azure File shared mounted as a volume is read-only.
bool
shareName
The name of the Azure File share to be mounted as a volume.
string (required)
storageAccountKey
The storage account access key used to access the Azure File share.
string
storageAccountName
The name of the storage account that contains the Azure File share.
string (required)
Quickstart templates
The following quickstart templates deploy this resource type.
ARM template resource definition
The containerGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.ContainerInstance/containerGroups resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2017-08-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"ports": [
{
"port": "int"
}
],
"resources": {
"limits": {
"cpu": "int",
"memoryInGB": "[json('decimal-as-string')]"
},
"requests": {
"cpu": "int",
"memoryInGB": "[json('decimal-as-string')]"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "Public"
},
"osType": "string",
"restartPolicy": "always",
"volumes": [
{
"azureFile": {
"readOnly": "bool",
"shareName": "string",
"storageAccountKey": "string",
"storageAccountName": "string"
},
"name": "string"
}
]
}
}
Property values
containerGroups
Name
Description
Value
type
The resource type
'Microsoft.ContainerInstance/containerGroups'
apiVersion
The resource api version
'2017-08-01-preview'
name
The resource name
string (required)
location
The resource location.
string (required)
tags
The resource tags.
Dictionary of tag names and values. See Tags in templates
properties
ContainerGroupProperties (required)
ContainerGroupProperties
Name
Description
Value
containers
The containers within the container group.
Container [] (required)
imageRegistryCredentials
The image registry credentials by which the container group is created from.
ImageRegistryCredential []
ipAddress
The IP address type of the container group.
IpAddress
osType
The operating system type required by the containers in the container group.
'Linux'
restartPolicy
Restart policy for all containers within the container group. Currently the only available option is always.
'always'
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (required)
ContainerProperties
Name
Description
Value
command
The commands to execute within the container instance in exec form.
string[]
environmentVariables
The environment variables to set in the container instance.
EnvironmentVariable []
image
The name of the image used to create the container instance.
string (required)
ports
The exposed ports on the container instance.
ContainerPort []
resources
The resource requirements of the container instance.
ResourceRequirements (required)
volumeMounts
The volume mounts available to the container instance.
VolumeMount []
EnvironmentVariable
Name
Description
Value
name
The name of the environment variable.
string (required)
value
The value of the environment variable.
string (required)
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
ResourceRequirements
Name
Description
Value
limits
The resource limits of this container instance.
ResourceLimits
requests
The resource requests of this container instance.
ResourceRequests (required)
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance. To specify a decimal value, use the json() function.
int or json decimal
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance. To specify a decimal value, use the json() function.
int or json decimal (required)
VolumeMount
Name
Description
Value
mountPath
The path within the container where the volume should be mounted. Must not contain colon (:).
string (required)
name
The name of the volume mount.
string (required)
readOnly
The flag indicating whether the volume mount is read-only.
bool
ImageRegistryCredential
Name
Description
Value
password
The password for the private registry.
string
server
The Docker image registry server without a protocol such as "http" and "https".
string (required)
username
The username for the private registry.
string (required)
IpAddress
Name
Description
Value
ip
The IP exposed to the public internet.
string
ports
The list of ports exposed on the container group.
Port [] (required)
type
Specifies if the IP is exposed to the public internet.
'Public' (required)
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
'TCP'
Volume
Name
Description
Value
azureFile
The name of the Azure File volume.
AzureFileVolume (required)
name
The name of the volume.
string (required)
AzureFileVolume
Name
Description
Value
readOnly
The flag indicating whether the Azure File shared mounted as a volume is read-only.
bool
shareName
The name of the Azure File share to be mounted as a volume.
string (required)
storageAccountKey
The storage account access key used to access the Azure File share.
string
storageAccountName
The name of the storage account that contains the Azure File share.
string (required)
Quickstart templates
The following quickstart templates deploy this resource type.
The containerGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.ContainerInstance/containerGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2017-08-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
containers = [
{
name = "string"
properties = {
command = [
"string"
]
environmentVariables = [
{
name = "string"
value = "string"
}
]
image = "string"
ports = [
{
port = int
}
]
resources = {
limits = {
cpu = int
memoryInGB = "decimal-as-string"
}
requests = {
cpu = int
memoryInGB = "decimal-as-string"
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "Public"
}
osType = "string"
restartPolicy = "always"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
name = "string"
}
]
}
})
}
Property values
containerGroups
Name
Description
Value
type
The resource type
"Microsoft.ContainerInstance/containerGroups@2017-08-01-preview"
name
The resource name
string (required)
location
The resource location.
string (required)
parent_id
To deploy to a resource group, use the ID of that resource group.
string (required)
tags
The resource tags.
Dictionary of tag names and values.
properties
ContainerGroupProperties (required)
ContainerGroupProperties
Name
Description
Value
containers
The containers within the container group.
Container [] (required)
imageRegistryCredentials
The image registry credentials by which the container group is created from.
ImageRegistryCredential []
ipAddress
The IP address type of the container group.
IpAddress
osType
The operating system type required by the containers in the container group.
"Linux"
restartPolicy
Restart policy for all containers within the container group. Currently the only available option is always.
"always"
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (required)
ContainerProperties
Name
Description
Value
command
The commands to execute within the container instance in exec form.
string[]
environmentVariables
The environment variables to set in the container instance.
EnvironmentVariable []
image
The name of the image used to create the container instance.
string (required)
ports
The exposed ports on the container instance.
ContainerPort []
resources
The resource requirements of the container instance.
ResourceRequirements (required)
volumeMounts
The volume mounts available to the container instance.
VolumeMount []
EnvironmentVariable
Name
Description
Value
name
The name of the environment variable.
string (required)
value
The value of the environment variable.
string (required)
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
ResourceRequirements
Name
Description
Value
limits
The resource limits of this container instance.
ResourceLimits
requests
The resource requests of this container instance.
ResourceRequests (required)
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance. Specify a decimal value as a string.
int or json decimal
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance. Specify a decimal value as a string.
int or json decimal (required)
VolumeMount
Name
Description
Value
mountPath
The path within the container where the volume should be mounted. Must not contain colon (:).
string (required)
name
The name of the volume mount.
string (required)
readOnly
The flag indicating whether the volume mount is read-only.
bool
ImageRegistryCredential
Name
Description
Value
password
The password for the private registry.
string
server
The Docker image registry server without a protocol such as "http" and "https".
string (required)
username
The username for the private registry.
string (required)
IpAddress
Name
Description
Value
ip
The IP exposed to the public internet.
string
ports
The list of ports exposed on the container group.
Port [] (required)
type
Specifies if the IP is exposed to the public internet.
"Public" (required)
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
"TCP"
Volume
Name
Description
Value
azureFile
The name of the Azure File volume.
AzureFileVolume (required)
name
The name of the volume.
string (required)
AzureFileVolume
Name
Description
Value
readOnly
The flag indicating whether the Azure File shared mounted as a volume is read-only.
bool
shareName
The name of the Azure File share to be mounted as a volume.
string (required)
storageAccountKey
The storage account access key used to access the Azure File share.
string
storageAccountName
The name of the storage account that contains the Azure File share.
string (required)
