Microsoft.ContainerInstance containerGroups 2017-12-01-preview
Artikel 01/13/2024
1 inzender
Feedback
In dit artikel
Bicep-resourcedefinitie
Het resourcetype containerGroups kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.ContainerInstance/containerGroups-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2017-12-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
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: {
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: {}
}
]
}
}
Eigenschapswaarden
containerGroups
Naam
Description
Waarde
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-63 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Kan niet beginnen of eindigen met afbreekstreepje. Opeenvolgende afbreekstreepjes zijn niet toegestaan.
location
De resourcelocatie.
tekenreeks (vereist)
tags
De resourcetags.
Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties
ContainerGroupProperties (vereist)
ContainerGroupProperties
Naam
Description
Waarde
containers
De containers binnen de containergroep.
Container [] (vereist)
imageRegistryCredentials
De registerreferenties van de installatiekopieën waarmee de containergroep wordt gemaakt.
ImageRegistryCredential []
ipAddress
Het IP-adrestype van de containergroep.
IpAddress
osType
Het type besturingssysteem dat is vereist voor de containers in de containergroep.
'Linux' 'Windows' (vereist)
restartPolicy
Beleid voor alle containers binnen de containergroep opnieuw opstarten. - Always
Altijd opnieuw opstarten - OnFailure
Opnieuw opstarten bij fout - Never
Nooit opnieuw opstarten
'Altijd' 'Nooit' 'OnFailure'
volumes
De lijst met volumes die kunnen worden gekoppeld door containers in deze containergroep.
Volume []
Container
Naam
Description
Waarde
naam
De door de gebruiker opgegeven naam van het containerexemplaar.
tekenreeks (vereist)
properties
De eigenschappen van de containerinstantie.
ContainerEigenschappen (vereist)
ContainerEigenschappen
Naam
Description
Waarde
command
De opdrachten die in exec-vorm moeten worden uitgevoerd in het containerexemplaar.
tekenreeks[]
environmentVariables
De omgevingsvariabelen die moeten worden ingesteld in het containerexemplaar.
EnvironmentVariable []
image
De naam van de installatiekopieën die worden gebruikt om het containerexemplaren te maken.
tekenreeks (vereist)
ports
De weergegeven poorten op het containerexemplaren.
ContainerPort []
resources
De resourcevereisten van het containerexemplaren.
ResourceRequirements (vereist)
volumeMounts
Het volume is beschikbaar voor het containerexemplaren.
VolumeMount []
OmgevingVariable
Naam
Description
Waarde
naam
De naam van de omgevingsvariabele.
tekenreeks (vereist)
waarde
De waarde van de omgevingsvariabele.
tekenreeks (vereist)
ContainerPort
Naam
Description
Waarde
poort
Het poortnummer dat binnen de containergroep wordt weergegeven.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
'TCP' UDP
ResourceRequirements
Naam
Description
Waarde
Grenzen
De resourcelimieten van dit containerexemplaren.
ResourceLimits
requests
De resourceaanvragen van dit containerexemplaren.
ResourceRequests (vereist)
ResourceLimits
Naam
Description
Waarde
Cpu
De CPU-limiet van dit containerexemplaren.
int
memoryInGB
De geheugenlimiet in GB van dit containerexemplaren. Als u een decimale waarde wilt opgeven, gebruikt u de functie json().
int of json decimaal
ResourceRequests
Naam
Description
Waarde
Cpu
De CPU-aanvraag van dit containerexemplaren.
int (vereist)
memoryInGB
De geheugenaanvraag in GB van dit containerexemplaren. Als u een decimale waarde wilt opgeven, gebruikt u de functie json().
int of json decimaal (vereist)
VolumeMount
Naam
Description
Waarde
mountPath
Het pad in de container waar het volume moet worden gekoppeld. Mag geen dubbele punt (:).
tekenreeks (vereist)
naam
De naam van de volumekoppeling.
tekenreeks (vereist)
Readonly
De vlag die aangeeft of de volumekoppeling alleen-lezen is.
booleaans
ImageRegistryCredential
Naam
Description
Waarde
wachtwoord
Het wachtwoord voor het privéregister.
tekenreeks
server
De Docker-installatiekopieënregisterserver zonder een protocol zoals 'http' en 'https'.
tekenreeks (vereist)
gebruikersnaam
De gebruikersnaam voor het privéregister.
tekenreeks (vereist)
IpAddress
Naam
Description
Waarde
IP
Het IP-adres dat wordt weergegeven op het openbare internet.
tekenreeks
ports
De lijst met poorten die worden weergegeven in de containergroep.
Poort [] (vereist)
type
Hiermee geeft u op of het IP-adres wordt blootgesteld aan het openbare internet.
'Openbaar' (vereist)
Poort
Naam
Description
Waarde
poort
het poortnummer.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
'TCP' UDP
Volume
Naam
Description
Waarde
azureFile
Het Azure File-volume.
AzureFileVolume
emptyDir
Het lege mapvolume.
Voor Bicep kunt u de functie any() gebruiken.
gitRepo
Het git-opslagplaatsvolume.
GitRepoVolume
naam
De naam van het volume.
tekenreeks (vereist)
geheim
Het geheime volume.
object
AzureFileVolume
Naam
Description
Waarde
Readonly
De vlag die aangeeft of de gedeelde Azure File die als volume is gekoppeld, alleen-lezen is.
booleaans
Sharenaam
De naam van de Azure-bestandsshare die moet worden gekoppeld als een volume.
tekenreeks (vereist)
storageAccountKey
De toegangssleutel voor het opslagaccount die wordt gebruikt voor toegang tot de Azure-bestandsshare.
tekenreeks
storageAccountName
De naam van het opslagaccount dat de Azure-bestandsshare bevat.
tekenreeks (vereist)
GitRepoVolume
Naam
Description
Waarde
map
Naam van doelmap. Mag niet bevatten of beginnen met '..'. Als '.' wordt opgegeven, wordt de volumemap de Git-opslagplaats. Anders bevat het volume, indien opgegeven, de Git-opslagplaats in de submap met de opgegeven naam.
tekenreeks
repository
URL van opslagplaats
tekenreeks (vereist)
revision
Hash doorvoeren voor de opgegeven revisie.
tekenreeks
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Resourcedefinitie van ARM-sjabloon
Het resourcetype containerGroups kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.ContainerInstance/containerGroups-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2017-12-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",
"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": {
"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": {}
}
]
}
}
Eigenschapswaarden
containerGroups
Naam
Description
Waarde
type
Het resourcetype
'Microsoft.ContainerInstance/containerGroups'
apiVersion
De resource-API-versie
'2017-12-01-preview'
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-63 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Kan niet beginnen of eindigen met afbreekstreepje. Opeenvolgende afbreekstreepjes zijn niet toegestaan.
location
De resourcelocatie.
tekenreeks (vereist)
tags
De resourcetags.
Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties
ContainerGroupProperties (vereist)
ContainerGroupProperties
Naam
Description
Waarde
containers
De containers binnen de containergroep.
Container [] (vereist)
imageRegistryCredentials
De registerreferenties van de installatiekopieën waarmee de containergroep wordt gemaakt.
ImageRegistryCredential []
ipAddress
Het IP-adrestype van de containergroep.
IpAddress
osType
Het type besturingssysteem dat is vereist voor de containers in de containergroep.
'Linux' 'Windows' (vereist)
restartPolicy
Beleid voor alle containers binnen de containergroep opnieuw opstarten. - Always
Altijd opnieuw opstarten - OnFailure
Opnieuw opstarten bij fout - Never
Nooit opnieuw opstarten
'Altijd' 'Nooit' 'OnFailure'
volumes
De lijst met volumes die kunnen worden gekoppeld door containers in deze containergroep.
Volume []
Container
Naam
Description
Waarde
naam
De door de gebruiker opgegeven naam van het containerexemplaar.
tekenreeks (vereist)
properties
De eigenschappen van de containerinstantie.
ContainerEigenschappen (vereist)
ContainerEigenschappen
Naam
Description
Waarde
command
De opdrachten die in exec-vorm moeten worden uitgevoerd in het containerexemplaren.
tekenreeks[]
environmentVariables
De omgevingsvariabelen die moeten worden ingesteld in het containerexemplaren.
EnvironmentVariable []
image
De naam van de installatiekopieën die worden gebruikt om het containerexemplaren te maken.
tekenreeks (vereist)
ports
De weergegeven poorten op het containerexemplaren.
ContainerPort []
resources
De resourcevereisten van het containerexemplaren.
ResourceRequirements (vereist)
volumeMounts
Het volume is beschikbaar voor het containerexemplaren.
VolumeMount []
OmgevingVariable
Naam
Description
Waarde
naam
De naam van de omgevingsvariabele.
tekenreeks (vereist)
waarde
De waarde van de omgevingsvariabele.
tekenreeks (vereist)
ContainerPort
Naam
Description
Waarde
poort
Het poortnummer dat binnen de containergroep wordt weergegeven.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
'TCP' UDP
ResourceRequirements
Naam
Description
Waarde
Grenzen
De resourcelimieten van dit containerexemplaren.
ResourceLimits
requests
De resourceaanvragen van dit containerexemplaren.
ResourceRequests (vereist)
ResourceLimits
Naam
Description
Waarde
Cpu
De CPU-limiet van dit containerexemplaren.
int
memoryInGB
De geheugenlimiet in GB van dit containerexemplaren. Als u een decimale waarde wilt opgeven, gebruikt u de functie json().
int of json decimaal
ResourceRequests
Naam
Description
Waarde
Cpu
De CPU-aanvraag van dit containerexemplaren.
int (vereist)
memoryInGB
De geheugenaanvraag in GB van dit containerexemplaren. Als u een decimale waarde wilt opgeven, gebruikt u de functie json().
int of json decimaal (vereist)
VolumeMount
Naam
Description
Waarde
mountPath
Het pad in de container waar het volume moet worden gekoppeld. Mag geen dubbele punt (:).
tekenreeks (vereist)
naam
De naam van de volumekoppeling.
tekenreeks (vereist)
Readonly
De vlag die aangeeft of de volumekoppeling alleen-lezen is.
booleaans
ImageRegistryCredential
Naam
Description
Waarde
wachtwoord
Het wachtwoord voor het privéregister.
tekenreeks
server
De Docker-installatiekopieënregisterserver zonder een protocol zoals 'http' en 'https'.
tekenreeks (vereist)
gebruikersnaam
De gebruikersnaam voor het privéregister.
tekenreeks (vereist)
IpAddress
Naam
Description
Waarde
IP
Het IP-adres dat wordt weergegeven op het openbare internet.
tekenreeks
ports
De lijst met poorten die worden weergegeven in de containergroep.
Poort [] (vereist)
type
Hiermee geeft u op of het IP-adres wordt blootgesteld aan het openbare internet.
'Openbaar' (vereist)
Poort
Naam
Description
Waarde
poort
het poortnummer.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
'TCP' UDP
Volume
Naam
Description
Waarde
azureFile
Het Azure File-volume.
AzureFileVolume
emptyDir
Het lege mapvolume.
gitRepo
Het git-opslagplaatsvolume.
GitRepoVolume
naam
De naam van het volume.
tekenreeks (vereist)
geheim
Het geheime volume.
object
AzureFileVolume
Naam
Description
Waarde
Readonly
De vlag die aangeeft of de gedeelde Azure File die als volume is gekoppeld, alleen-lezen is.
booleaans
Sharenaam
De naam van de Azure-bestandsshare die moet worden gekoppeld als een volume.
tekenreeks (vereist)
storageAccountKey
De toegangssleutel voor het opslagaccount die wordt gebruikt voor toegang tot de Azure-bestandsshare.
tekenreeks
storageAccountName
De naam van het opslagaccount dat de Azure-bestandsshare bevat.
tekenreeks (vereist)
GitRepoVolume
Naam
Description
Waarde
map
Naam van doelmap. Mag niet bevatten of beginnen met '..'. Als '.' wordt opgegeven, wordt de volumemap de Git-opslagplaats. Anders bevat het volume, indien opgegeven, de Git-opslagplaats in de submap met de opgegeven naam.
tekenreeks
repository
URL van opslagplaats
tekenreeks (vereist)
revision
Hash doorvoeren voor de opgegeven revisie.
tekenreeks
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Het resourcetype containerGroups kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.ContainerInstance/containerGroups-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2017-12-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
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 = {
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 = {}
}
]
}
})
}
Eigenschapswaarden
containerGroups
Naam
Description
Waarde
type
Het resourcetype
"Microsoft.ContainerInstance/containerGroups@2017-12-01-preview"
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-63 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Kan niet beginnen of eindigen met afbreekstreepje. Opeenvolgende afbreekstreepjes zijn niet toegestaan.
location
De resourcelocatie.
tekenreeks (vereist)
parent_id
Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep.
tekenreeks (vereist)
tags
De resourcetags.
Woordenlijst met tagnamen en -waarden.
properties
ContainerGroupProperties (vereist)
ContainerGroupProperties
Naam
Description
Waarde
containers
De containers binnen de containergroep.
Container [] (vereist)
imageRegistryCredentials
De registerreferenties van de installatiekopieën waarmee de containergroep wordt gemaakt.
ImageRegistryCredential []
ipAddress
Het IP-adrestype van de containergroep.
IpAddress
osType
Het type besturingssysteem dat is vereist voor de containers in de containergroep.
"Linux" "Windows" (vereist)
restartPolicy
Beleid voor alle containers binnen de containergroep opnieuw opstarten. - Always
Altijd opnieuw opstarten - OnFailure
Opnieuw opstarten bij fout - Never
Nooit opnieuw opstarten
"Altijd" "Nooit" "OnFailure"
volumes
De lijst met volumes die kunnen worden gekoppeld door containers in deze containergroep.
Volume []
Container
Naam
Description
Waarde
naam
De door de gebruiker opgegeven naam van het containerexemplaar.
tekenreeks (vereist)
properties
De eigenschappen van het containerexemplaren.
ContainerEigenschappen (vereist)
ContainerEigenschappen
Naam
Description
Waarde
command
De opdrachten die in exec-vorm moeten worden uitgevoerd in het containerexemplaren.
tekenreeks[]
environmentVariables
De omgevingsvariabelen die moeten worden ingesteld in het containerexemplaren.
EnvironmentVariable []
image
De naam van de installatiekopieën die worden gebruikt om het containerexemplaren te maken.
tekenreeks (vereist)
ports
De weergegeven poorten op het containerexemplaren.
ContainerPort []
resources
De resourcevereisten van het containerexemplaren.
ResourceRequirements (vereist)
volumeMounts
Het volume is beschikbaar voor het containerexemplaren.
VolumeMount []
OmgevingVariable
Naam
Description
Waarde
naam
De naam van de omgevingsvariabele.
tekenreeks (vereist)
waarde
De waarde van de omgevingsvariabele.
tekenreeks (vereist)
ContainerPort
Naam
Description
Waarde
poort
Het poortnummer dat binnen de containergroep wordt weergegeven.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
"TCP" "UDP"
ResourceRequirements
Naam
Description
Waarde
Grenzen
De resourcelimieten van dit containerexemplaren.
ResourceLimits
requests
De resourceaanvragen van dit containerexemplaren.
ResourceRequests (vereist)
ResourceLimits
Naam
Description
Waarde
Cpu
De CPU-limiet van dit containerexemplaren.
int
memoryInGB
De geheugenlimiet in GB van dit containerexemplaren. Geef een decimale waarde op als een tekenreeks.
int of json decimaal
ResourceRequests
Naam
Description
Waarde
Cpu
De CPU-aanvraag van dit containerexemplaren.
int (vereist)
memoryInGB
De geheugenaanvraag in GB van dit containerexemplaren. Geef een decimale waarde op als een tekenreeks.
int of json decimaal (vereist)
VolumeMount
Naam
Description
Waarde
mountPath
Het pad in de container waar het volume moet worden gekoppeld. Mag geen dubbele punt (:).
tekenreeks (vereist)
naam
De naam van de volumekoppeling.
tekenreeks (vereist)
Readonly
De vlag die aangeeft of de volumekoppeling alleen-lezen is.
booleaans
ImageRegistryCredential
Naam
Description
Waarde
wachtwoord
Het wachtwoord voor het privéregister.
tekenreeks
server
De docker-installatiekopieënregisterserver zonder een protocol zoals 'http' en 'https'.
tekenreeks (vereist)
gebruikersnaam
De gebruikersnaam voor het privéregister.
tekenreeks (vereist)
IpAddress
Naam
Description
Waarde
IP
Het IP-adres dat wordt weergegeven op het openbare internet.
tekenreeks
ports
De lijst met poorten die beschikbaar zijn voor de containergroep.
Poort [] (vereist)
type
Hiermee geeft u op of het IP-adres wordt weergegeven op het openbare internet.
'Openbaar' (vereist)
Poort
Naam
Description
Waarde
poort
het poortnummer.
int (vereist)
protocol
Het protocol dat is gekoppeld aan de poort.
"TCP" "UDP"
Volume
Naam
Description
Waarde
azureFile
Het Azure File-volume.
AzureFileVolume
emptyDir
Het lege mapvolume.
gitRepo
Het git-opslagplaatsvolume.
GitRepoVolume
naam
De naam van het volume.
tekenreeks (vereist)
geheim
Het geheime volume.
object
AzureFileVolume
Naam
Description
Waarde
Readonly
De vlag die aangeeft of het gedeelde Azure-bestand dat als volume is gekoppeld, alleen-lezen is.
booleaans
Sharenaam
De naam van de Azure-bestandsshare die als volume moet worden gekoppeld.
tekenreeks (vereist)
storageAccountKey
De toegangssleutel van het opslagaccount die wordt gebruikt voor toegang tot de Azure-bestandsshare.
tekenreeks
storageAccountName
De naam van het opslagaccount dat de Azure-bestandsshare bevat.
tekenreeks (vereist)
GitRepoVolume
Naam
Description
Waarde
map
Naam van doelmap. Mag niet bevatten of beginnen met '..'. Als '.' wordt opgegeven, wordt de volumemap de Git-opslagplaats. Anders bevat het volume, indien opgegeven, de Git-opslagplaats in de submap met de opgegeven naam.
tekenreeks
repository
URL van opslagplaats
tekenreeks (vereist)
revision
Hash doorvoeren voor de opgegeven revisie.
tekenreeks