Microsoft.ContainerInstance containerGroups 2017-12-01-preview
Article 12/09/2024
2 contributors
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-12-01-preview' = {
location: 'string'
name: 'string'
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
value: 'string'
}
]
image: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
resources: {
limits: {
cpu: int
memoryInGB: int
}
requests: {
cpu: int
memoryInGB: int
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'string'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
emptyDir: any(Azure.Bicep.Types.Concrete.AnyType)
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {
{customized property}: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Property values
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)
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (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' 'Windows' (required)
restartPolicy
Restart policy for all containers within the container group. - Always
Always restart - OnFailure
Restart on failure - Never
Never restart
'Always' 'Never' 'OnFailure'
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
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)
GitRepoVolume
Name
Description
Value
directory
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.
string
repository
Repository URL
string (required)
revision
Commit hash for the specified revision.
string
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)
Microsoft.ContainerInstance/containerGroups
Name
Description
Value
location
The resource location.
string (required)
name
The resource name
string (required)
properties
ContainerGroupProperties (required)
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance.
int
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance.
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)
SecretVolume
Volume
Name
Description
Value
azureFile
The Azure File volume.
AzureFileVolume
emptyDir
The empty directory volume.
any
gitRepo
The git repo volume.
GitRepoVolume
name
The name of the volume.
string (required)
secret
The secret volume.
SecretVolume
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
Quickstart samples
The following quickstart samples 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-12-01-preview",
"name": "string",
"location": "string",
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"resources": {
"limits": {
"cpu": "int",
"memoryInGB": "int"
},
"requests": {
"cpu": "int",
"memoryInGB": "int"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "string"
},
"osType": "string",
"restartPolicy": "string",
"volumes": [
{
"azureFile": {
"readOnly": "bool",
"shareName": "string",
"storageAccountKey": "string",
"storageAccountName": "string"
},
"emptyDir": {},
"gitRepo": {
"directory": "string",
"repository": "string",
"revision": "string"
},
"name": "string",
"secret": {
"{customized property}": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property values
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)
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (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' 'Windows' (required)
restartPolicy
Restart policy for all containers within the container group. - Always
Always restart - OnFailure
Restart on failure - Never
Never restart
'Always' 'Never' 'OnFailure'
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
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)
GitRepoVolume
Name
Description
Value
directory
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.
string
repository
Repository URL
string (required)
revision
Commit hash for the specified revision.
string
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)
Microsoft.ContainerInstance/containerGroups
Name
Description
Value
apiVersion
The api version
'2017-12-01-preview'
location
The resource location.
string (required)
name
The resource name
string (required)
properties
ContainerGroupProperties (required)
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.ContainerInstance/containerGroups'
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance.
int
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance.
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)
SecretVolume
Volume
Name
Description
Value
azureFile
The Azure File volume.
AzureFileVolume
emptyDir
The empty directory volume.
any
gitRepo
The git repo volume.
GitRepoVolume
name
The name of the volume.
string (required)
secret
The secret volume.
SecretVolume
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
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-12-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
containers = [
{
name = "string"
properties = {
command = [
"string"
]
environmentVariables = [
{
name = "string"
value = "string"
}
]
image = "string"
ports = [
{
port = int
protocol = "string"
}
]
resources = {
limits = {
cpu = int
memoryInGB = int
}
requests = {
cpu = int
memoryInGB = int
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "string"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
emptyDir = ?
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {
{customized property} = "string"
}
}
]
}
})
}
Property values
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)
Container
Name
Description
Value
name
The user-provided name of the container instance.
string (required)
properties
The properties of the container instance.
ContainerProperties (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' 'Windows' (required)
restartPolicy
Restart policy for all containers within the container group. - Always
Always restart - OnFailure
Restart on failure - Never
Never restart
'Always' 'Never' 'OnFailure'
volumes
The list of volumes that can be mounted by containers in this container group.
Volume []
ContainerPort
Name
Description
Value
port
The port number exposed within the container group.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
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)
GitRepoVolume
Name
Description
Value
directory
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.
string
repository
Repository URL
string (required)
revision
Commit hash for the specified revision.
string
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)
Microsoft.ContainerInstance/containerGroups
Name
Description
Value
location
The resource location.
string (required)
name
The resource name
string (required)
properties
ContainerGroupProperties (required)
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.ContainerInstance/containerGroups@2017-12-01-preview"
Port
Name
Description
Value
port
The port number.
int (required)
protocol
The protocol associated with the port.
'TCP' 'UDP'
ResourceLimits
Name
Description
Value
cpu
The CPU limit of this container instance.
int
memoryInGB
The memory limit in GB of this container instance.
int
ResourceRequests
Name
Description
Value
cpu
The CPU request of this container instance.
int (required)
memoryInGB
The memory request in GB of this container instance.
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)
SecretVolume
Volume
Name
Description
Value
azureFile
The Azure File volume.
AzureFileVolume
emptyDir
The empty directory volume.
any
gitRepo
The git repo volume.
GitRepoVolume
name
The name of the volume.
string (required)
secret
The secret volume.
SecretVolume
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