Microsoft.ContainerInstance containerGroups 2018-04-01
Article 05/11/2023
1 contributeur
Commentaires
Dans cet article
Définition de ressource Bicep
Le type de ressource containerGroups peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ContainerInstance/containerGroups, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-04-01' = {
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
protocol: 'string'
}
]
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: {
dnsNameLabel: 'string'
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'Public'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
emptyDir: any()
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {}
}
]
}
}
Valeurs de propriétés
containerGroups
Nom
Description
Valeur
name
Nom de la ressource
chaîne (obligatoire) Limite de caractères : 1-63 Caractères valides : Lettres minuscules, chiffres et traits d’union. Ne peut pas commencer ou se terminer par un trait d’union. Les traits d’union consécutifs ne sont pas autorisés.
location
Emplacement de la ressource.
string
tags
Étiquettes de la ressource.
Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties
ContainerGroupProperties (obligatoire)
ContainerGroupProperties
Nom
Description
Valeur
containers
Conteneurs présents dans le groupe de conteneurs.
Container [] (obligatoire)
imageRegistryCredentials
Informations d’identification du registre d’images à partir desquelles le groupe de conteneurs est créé.
ImageRegistryCredential []
ipAddress
Type d’adresse IP du groupe de conteneurs.
IpAddress
osType
Type de système d’exploitation exigé par les conteneurs présents dans le groupe de conteneurs.
'Linux' 'Windows' (obligatoire)
restartPolicy
Stratégie de redémarrage pour tous les conteneurs présents dans le groupe de conteneurs. - Always
Toujours redémarrer - OnFailure
Redémarrer en cas d’échec - Never
Ne redémarrez jamais
'Always' 'Jamais' 'OnFailure'
volumes
Liste des volumes qui peuvent être montés par les conteneurs présents dans ce groupe de conteneurs.
Volume []
Conteneur
Nom
Description
Valeur
name
Nom fourni par l’utilisateur de l’instance de conteneur.
chaîne (obligatoire)
properties
Propriétés de l’instance de conteneur.
ContainerProperties (obligatoire)
ContainerProperties
Nom
Description
Valeur
command
Commandes à exécuter dans l’instance de conteneur dans l’exec form.
string[]
environmentVariables
Variable d’environnement à définir dans l’instance de conteneur.
EnvironmentVariable []
image
Nom de l’image utilisée pour créer l’instance de conteneur.
string (obligatoire)
ports
Port exposé dans l’instance de conteneur.
ContainerPort []
les ressources
Besoins en ressources de l’instance de conteneur.
ResourceRequirements (obligatoire)
volumeMounts
Montages de volume accessibles à l’instance de conteneur.
VolumeMount []
EnvironmentVariable
Nom
Description
Valeur
name
Nom de la variable d’environnement.
string (obligatoire)
value
Valeur de la variable d’environnement.
string (obligatoire)
ContainerPort
Nom
Description
Valeur
port
Numéro de port exposé dans le groupe de conteneurs.
int (obligatoire)
protocol
Protocole associé au port.
'TCP' 'UDP'
ResourceRequirements
Nom
Description
Valeur
limites
Limites en ressources de cette instance de conteneur.
ResourceLimits
requêtes
Demandes en ressources de cette instance de conteneur.
ResourceRequests (obligatoire)
ResourceLimits
Nom
Description
Valeur
cpu
Limite processeur de cette instance de conteneur.
int
memoryInGB
Limite de mémoire en Go de cette instance de conteneur. Pour spécifier une valeur décimale, utilisez la fonction json().
int ou json decimal
ResourceRequests
Nom
Description
Valeur
cpu
Demande de processeur de cette instance de conteneur.
int (obligatoire)
memoryInGB
Demande de mémoire en Go de cette instance de conteneur. Pour spécifier une valeur décimale, utilisez la fonction json().
int ou json decimal (obligatoire)
VolumeMount
Nom
Description
Valeur
mountPath
Chemin de l’emplacement dans le conteneur où le volume doit être monté. Ne doit pas contenir de signe deux-points (:).
string (obligatoire)
name
Nom du montage de volume.
string (obligatoire)
readOnly
Indicateur précisant si le montage du volume est en lecture seule.
bool
ImageRegistryCredential
Nom
Description
Valeur
mot de passe
Mot de passe du registre privé.
string
server
Serveur de registre d’images Docker sans protocole comme « http » ou « https ».
string (obligatoire)
username
Nom d’utilisateur du registre privé.
string (obligatoire)
IpAddress
Nom
Description
Valeur
dnsNameLabel
Étiquette du nom DNS de l’adresse IP.
string
ip
Adresse IP exposée à l’Internet public.
string
ports
Liste des ports exposés dans le groupe de conteneurs.
Port [] (obligatoire)
type
Spécifie si l’adresse IP est exposée à l’Internet public.
'Public' (obligatoire)
Port
Nom
Description
Valeur
port
Numéro de port.
int (obligatoire)
protocol
Protocole associé au port.
'TCP' 'UDP'
Volume
Nom
Description
Valeur
azureFile
Volume de fichier Azure.
AzureFileVolume
emptyDir
Volume de répertoire vide.
Pour Bicep, vous pouvez utiliser la fonction any().
gitRepo
Volume de dépôt git.
GitRepoVolume
name
Nom du volume.
chaîne (obligatoire)
secret
Volume de secret.
object
AzureFileVolume
Nom
Description
Valeur
readOnly
Indicateur précisant si le partage de fichiers Azure monté en tant que volume est en lecture seule.
bool
shareName
Nom du partage de fichiers Azure à monter en tant que volume.
chaîne (obligatoire)
storageAccountKey
Clé d’accès du compte de stockage utilisée pour accéder au partage de fichiers Azure.
string
storageAccountName
Nom du compte de stockage qui contient le partage de fichiers Azure.
chaîne (obligatoire)
GitRepoVolume
Nom
Description
Valeur
directory
Nom du répertoire cible. Ne doit pas contenir ou commencer par « .. ». Si « . » est spécifié, le répertoire du volume est le dépôt git. Sinon, s’il est spécifié, le volume contient le dépôt git dans le sous-répertoire avec le nom donné.
string
repository
URL du dépôt
chaîne (obligatoire)
revision
Hachage de validation pour la révision spécifiée.
string
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
Définition de ressources de modèle ARM
Le type de ressource containerGroups peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ContainerInstance/containerGroups, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-04-01",
"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",
"protocol": "string"
}
],
"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": {
"dnsNameLabel": "string",
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "Public"
},
"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": {}
}
]
}
}
Valeurs de propriétés
containerGroups
Nom
Description
Valeur
type
Type de ressource
'Microsoft.ContainerInstance/containerGroups'
apiVersion
Version de l’API de ressource
'2018-04-01'
name
Nom de la ressource
string (obligatoire) Limite de caractères : 1-63 Caractères valides : Lettres minuscules, chiffres et traits d’union. Ne peut pas commencer ou se terminer par un trait d’union. Les traits d’union consécutifs ne sont pas autorisés.
location
Emplacement de la ressource.
string
tags
Étiquettes de la ressource.
Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties
ContainerGroupProperties (obligatoire)
ContainerGroupProperties
Nom
Description
Valeur
containers
Conteneurs présents dans le groupe de conteneurs.
Container [] (obligatoire)
imageRegistryCredentials
Informations d’identification du registre d’images à partir desquelles le groupe de conteneurs est créé.
ImageRegistryCredential []
ipAddress
Type d’adresse IP du groupe de conteneurs.
IpAddress
osType
Type de système d’exploitation exigé par les conteneurs présents dans le groupe de conteneurs.
'Linux' 'Windows' (obligatoire)
restartPolicy
Stratégie de redémarrage pour tous les conteneurs présents dans le groupe de conteneurs. - Always
Toujours redémarrer - OnFailure
Redémarrer en cas d’échec - Never
Ne jamais redémarrer
'Always' 'Jamais' 'OnFailure'
volumes
Liste des volumes qui peuvent être montés par les conteneurs présents dans ce groupe de conteneurs.
Volume []
Conteneur
Nom
Description
Valeur
name
Nom fourni par l’utilisateur de l’instance de conteneur.
string (obligatoire)
properties
Propriétés de l’instance de conteneur.
ContainerProperties (obligatoire)
ContainerProperties
Nom
Description
Valeur
command
Commandes à exécuter dans l’instance de conteneur dans l’exec form.
string[]
environmentVariables
Variable d’environnement à définir dans l’instance de conteneur.
EnvironmentVariable []
image
Nom de l’image utilisée pour créer l’instance de conteneur.
chaîne (obligatoire)
ports
Port exposé dans l’instance de conteneur.
ContainerPort []
les ressources
Besoins en ressources de l’instance de conteneur.
ResourceRequirements (obligatoire)
volumeMounts
Montages de volume accessibles à l’instance de conteneur.
VolumeMount []
EnvironmentVariable
Nom
Description
Valeur
name
Nom de la variable d’environnement.
chaîne (obligatoire)
value
Valeur de la variable d’environnement.
chaîne (obligatoire)
ContainerPort
Nom
Description
Valeur
port
Numéro de port exposé dans le groupe de conteneurs.
int (obligatoire)
protocol
Protocole associé au port.
'TCP' 'UDP'
ResourceRequirements
Nom
Description
Valeur
limites
Limites en ressources de cette instance de conteneur.
ResourceLimits
requêtes
Demandes en ressources de cette instance de conteneur.
ResourceRequests (obligatoire)
ResourceLimits
Nom
Description
Valeur
cpu
Limite processeur de cette instance de conteneur.
int
memoryInGB
Limite de mémoire en Go de cette instance de conteneur. Pour spécifier une valeur décimale, utilisez la fonction json().
décimal int ou json
ResourceRequests
Nom
Description
Valeur
cpu
Demande de processeur de cette instance de conteneur.
int (obligatoire)
memoryInGB
Demande de mémoire en Go de cette instance de conteneur. Pour spécifier une valeur décimale, utilisez la fonction json().
décimal int ou json (obligatoire)
VolumeMount
Nom
Description
Valeur
mountPath
Chemin de l’emplacement dans le conteneur où le volume doit être monté. Ne doit pas contenir de signe deux-points (:).
chaîne (obligatoire)
name
Nom du montage de volume.
chaîne (obligatoire)
readOnly
Indicateur précisant si le montage du volume est en lecture seule.
bool
ImageRegistryCredential
Nom
Description
Valeur
mot de passe
Mot de passe du registre privé.
string
server
Serveur de registre d’images Docker sans protocole comme « http » ou « https ».
chaîne (obligatoire)
username
Nom d’utilisateur du registre privé.
chaîne (obligatoire)
IpAddress
Nom
Description
Valeur
dnsNameLabel
Étiquette du nom DNS de l’adresse IP.
string
ip
Adresse IP exposée à l’Internet public.
string
ports
Liste des ports exposés dans le groupe de conteneurs.
Port [] (obligatoire)
type
Spécifie si l’adresse IP est exposée à l’Internet public.
'Public' (obligatoire)
Port
Nom
Description
Valeur
port
Numéro de port.
int (obligatoire)
protocol
Protocole associé au port.
'TCP' 'UDP'
Volume
Nom
Description
Valeur
azureFile
Volume de fichier Azure.
AzureFileVolume
emptyDir
Volume de répertoire vide.
gitRepo
Volume de dépôt git.
GitRepoVolume
name
Nom du volume.
chaîne (obligatoire)
secret
Volume de secret.
object
AzureFileVolume
Nom
Description
Valeur
readOnly
Indicateur précisant si le partage de fichiers Azure monté en tant que volume est en lecture seule.
bool
shareName
Nom du partage de fichiers Azure à monter en tant que volume.
chaîne (obligatoire)
storageAccountKey
Clé d’accès du compte de stockage utilisée pour accéder au partage de fichiers Azure.
string
storageAccountName
Nom du compte de stockage qui contient le partage de fichiers Azure.
chaîne (obligatoire)
GitRepoVolume
Nom
Description
Valeur
directory
Nom du répertoire cible. Ne doit pas contenir ou commencer par « .. ». Si « . » est spécifié, le répertoire du volume est le dépôt git. Sinon, s’il est spécifié, le volume contient le dépôt git dans le sous-répertoire avec le nom donné.
string
repository
URL du dépôt
chaîne (obligatoire)
revision
Hachage de validation pour la révision spécifiée.
string
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
Le type de ressource containerGroups peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ContainerInstance/containerGroups, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-04-01"
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
protocol = "string"
}
]
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 = {
dnsNameLabel = "string"
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "Public"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {}
}
]
}
})
}
Valeurs de propriétés
containerGroups
Nom
Description
Valeur
type
Type de ressource
« Microsoft.ContainerInstance/containerGroups@2018-04-01 »
name
Nom de la ressource
chaîne (obligatoire) Limite de caractères : 1-63 Caractères valides : Lettres minuscules, chiffres et traits d’union. Ne peut pas commencer ou se terminer par un trait d’union. Les traits d’union consécutifs ne sont pas autorisés.
location
Emplacement de la ressource.
string
parent_id
Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.
chaîne (obligatoire)
tags
Étiquettes de la ressource.
Dictionnaire de noms et de valeurs d’étiquettes.
properties
ContainerGroupProperties (obligatoire)
ContainerGroupProperties
Nom
Description
Valeur
containers
Conteneurs présents dans le groupe de conteneurs.
Container [] (obligatoire)
imageRegistryCredentials
Informations d’identification du registre d’images à partir desquelles le groupe de conteneurs est créé.
ImageRegistryCredential []
ipAddress
Type d’adresse IP du groupe de conteneurs.
IpAddress
osType
Type de système d’exploitation exigé par les conteneurs présents dans le groupe de conteneurs.
« Linux » « Windows » (obligatoire)
restartPolicy
Stratégie de redémarrage pour tous les conteneurs présents dans le groupe de conteneurs. - Always
Toujours redémarrer - OnFailure
Redémarrer en cas d’échec - Never
Ne redémarrez jamais
« Always » « Jamais » « OnFailure »
volumes
Liste des volumes qui peuvent être montés par les conteneurs présents dans ce groupe de conteneurs.
Volume []
Conteneur
Nom
Description
Valeur
name
Nom fourni par l’utilisateur de l’instance de conteneur.
string (obligatoire)
properties
Propriétés de l’instance de conteneur.
ContainerProperties (obligatoire)
ContainerProperties
Nom
Description
Valeur
command
Commandes à exécuter dans l’instance de conteneur dans l’exec form.
string[]
environmentVariables
Variable d’environnement à définir dans l’instance de conteneur.
EnvironmentVariable []
image
Nom de l’image utilisée pour créer l’instance de conteneur.
string (obligatoire)
ports
Port exposé dans l’instance de conteneur.
ContainerPort []
les ressources
Besoins en ressources de l’instance de conteneur.
ResourceRequirements (obligatoire)
volumeMounts
Montages de volume accessibles à l’instance de conteneur.
VolumeMount []
EnvironmentVariable
Nom
Description
Valeur
name
Nom de la variable d’environnement.
string (obligatoire)
value
Valeur de la variable d’environnement.
string (obligatoire)
ContainerPort
Nom
Description
Valeur
port
Numéro de port exposé dans le groupe de conteneurs.
int (obligatoire)
protocol
Protocole associé au port.
« TCP » « UDP »
ResourceRequirements
Nom
Description
Valeur
limites
Limites en ressources de cette instance de conteneur.
ResourceLimits
requêtes
Demandes en ressources de cette instance de conteneur.
ResourceRequests (obligatoire)
ResourceLimits
Nom
Description
Valeur
cpu
Limite processeur de cette instance de conteneur.
int
memoryInGB
Limite de mémoire en Go de cette instance de conteneur. Spécifiez une valeur décimale sous forme de chaîne.
int ou json decimal
ResourceRequests
Nom
Description
Valeur
cpu
Demande de processeur de cette instance de conteneur.
int (obligatoire)
memoryInGB
Demande de mémoire en Go de cette instance de conteneur. Spécifiez une valeur décimale sous forme de chaîne.
int ou json decimal (obligatoire)
VolumeMount
Nom
Description
Valeur
mountPath
Chemin de l’emplacement dans le conteneur où le volume doit être monté. Ne doit pas contenir de signe deux-points (:).
string (obligatoire)
name
Nom du montage de volume.
string (obligatoire)
readOnly
Indicateur précisant si le montage du volume est en lecture seule.
bool
ImageRegistryCredential
Nom
Description
Valeur
mot de passe
Mot de passe du registre privé.
string
server
Serveur de registre d’images Docker sans protocole comme « http » ou « https ».
chaîne (obligatoire)
username
Nom d’utilisateur du registre privé.
chaîne (obligatoire)
IpAddress
Nom
Description
Valeur
dnsNameLabel
Étiquette du nom DNS de l’adresse IP.
string
ip
Adresse IP exposée à l’Internet public.
string
ports
Liste des ports exposés dans le groupe de conteneurs.
Port [] (obligatoire)
type
Spécifie si l’adresse IP est exposée à l’Internet public.
« Public » (obligatoire)
Port
Nom
Description
Valeur
port
Numéro de port.
int (obligatoire)
protocol
Protocole associé au port.
« TCP » « UDP »
Volume
Nom
Description
Valeur
azureFile
Volume de fichier Azure.
AzureFileVolume
emptyDir
Volume de répertoire vide.
gitRepo
Volume de dépôt git.
GitRepoVolume
name
Nom du volume.
chaîne (obligatoire)
secret
Volume de secret.
object
AzureFileVolume
Nom
Description
Valeur
readOnly
Indicateur précisant si le partage de fichiers Azure monté en tant que volume est en lecture seule.
bool
shareName
Nom du partage de fichiers Azure à monter en tant que volume.
chaîne (obligatoire)
storageAccountKey
Clé d’accès du compte de stockage utilisée pour accéder au partage de fichiers Azure.
string
storageAccountName
Nom du compte de stockage qui contient le partage de fichiers Azure.
chaîne (obligatoire)
GitRepoVolume
Nom
Description
Valeur
directory
Nom du répertoire cible. Ne doit pas contenir ou commencer par « .. ». Si « . » est spécifié, le répertoire du volume est le dépôt git. Sinon, s’il est spécifié, le volume contient le dépôt git dans le sous-répertoire avec le nom donné.
string
repository
URL du dépôt
chaîne (obligatoire)
revision
Hachage de validation pour la révision spécifiée.
string