YAML-Referenz: Azure Container InstancesYAML reference: Azure Container Instances

Dieser Artikel behandelt die Syntax und Eigenschaften für die von Azure Container Instances zum Konfigurieren einer Containergruppe unterstützte YAML-Datei.This article covers the syntax and properties for the YAML file supported by Azure Container Instances to configure a container group. Verwenden Sie eine YAML-Datei, um die Gruppenkonfiguration in den Befehl az container create in der Azure CLI einzugeben.Use a YAML file to input the group configuration to the az container create command in the Azure CLI.

Eine YAML-Datei ist eine bequeme Möglichkeit, um eine Containergruppe für reproduzierbare Bereitstellungen zu konfigurieren.A YAML file is a convenient way to configure a container group for reproducible deployments. Dies ist eine präzise Alternative zur Verwendung einer Resource Manager-Vorlage oder des Azure Container Instances SDKs zum Erstellen oder Aktualisieren einer Containergruppe.It is a concise alternative to using a Resource Manager template or the Azure Container Instances SDKs to create or update a container group.

Hinweis

Diese Referenz gilt für YAML-Dateien für Azure Container Instances-REST-API-Version 2019-12-01.This reference applies to YAML files for Azure Container Instances REST API version 2019-12-01.

SchemaSchema

Im Folgenden finden Sie das Schema für die YAML-Datei, einschließlich Kommentaren zur Hervorhebung von wichtigen Eigenschaften.The schema for the YAML file follows, including comments to highlight key properties. Eine Beschreibung der Eigenschaften in diesem Schema finden Sie im Abschnitt Eigenschaftswerte.For a description of the properties in this schema, see the Property values section.

name: string  # Name of the container group
apiVersion: '2019-12-01'
location: string
tags: {}
identity: 
  type: string
  userAssignedIdentities: {}
properties: # Properties of container group
  containers: # Array of container instances in the group
  - name: string # Name of an instance
    properties: # Properties of an instance
      image: string # Container image used to create the instance
      command:
      - string
      ports: # External-facing ports exposed on the instance, must also be set in group ipAddress property 
      - protocol: string
        port: integer
      environmentVariables:
      - name: string
        value: string
        secureValue: string
      resources: # Resource requirements of the instance
        requests:
          memoryInGB: number
          cpu: number
          gpu:
            count: integer
            sku: string
        limits:
          memoryInGB: number
          cpu: number
          gpu:
            count: integer
            sku: string
      volumeMounts: # Array of volume mounts for the instance
      - name: string
        mountPath: string
        readOnly: boolean
      livenessProbe:
        exec:
          command:
          - string
        httpGet:
          path: string
          port: integer
          scheme: string
        initialDelaySeconds: integer
        periodSeconds: integer
        failureThreshold: integer
        successThreshold: integer
        timeoutSeconds: integer
      readinessProbe:
        exec:
          command:
          - string
        httpGet:
          path: string
          port: integer
          scheme: string
        initialDelaySeconds: integer
        periodSeconds: integer
        failureThreshold: integer
        successThreshold: integer
        timeoutSeconds: integer
  imageRegistryCredentials: # Credentials to pull a private image
  - server: string
    username: string
    password: string
  restartPolicy: string
  ipAddress: # IP address configuration of container group
    ports:
    - protocol: string
      port: integer
    type: string
    ip: string
    dnsNameLabel: string
  osType: string
  volumes: # Array of volumes available to the instances
  - name: string
    azureFile:
      shareName: string
      readOnly: boolean
      storageAccountName: string
      storageAccountKey: string
    emptyDir: {}
    secret: {}
    gitRepo:
      directory: string
      repository: string
      revision: string
  diagnostics:
    logAnalytics:
      workspaceId: string
      workspaceKey: string
      logType: string
      metadata: {}
  networkProfile: # Virtual network profile for container group
    id: string
  dnsConfig: # DNS configuration for container group
    nameServers:
    - string
    searchDomains: string
    options: string
  sku: string # SKU for the container group
  encryptionProperties:
    vaultBaseUrl: string
    keyName: string
    keyVersion: string
  initContainers: # Array of init containers in the group
  - name: string
    properties:
      image: string
      command:
      - string
      environmentVariables:
      - name: string
        value: string
        secureValue: string
      volumeMounts:
      - name: string
        mountPath: string
        readOnly: boolean

EigenschaftswerteProperty values

In den folgenden Tabellen sind die Werte beschrieben, die Sie im Schema festlegen müssen.The following tables describe the values you need to set in the schema.

Microsoft.ContainerInstance/containerGroups-ObjektMicrosoft.ContainerInstance/containerGroups object

NameName typeType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der Name der Containergruppe.The name of the container group.
apiVersionapiVersion enumenum JaYes 2018-10-012018-10-01
locationlocation Zeichenfolgestring NeinNo Der Ressourcenspeicherort.The resource location.
tagstags Objekt (object)object NeinNo Die Ressourcentags.The resource tags.
identityidentity Objekt (object)object NeinNo Die Identität der Containergruppe, sofern konfiguriert.The identity of the container group, if configured. - -Objekt - ContainerGroupIdentity object
propertiesproperties Objekt (object)object JaYes ContainerGroupProperties-ObjektContainerGroupProperties object

ContainerGroupIdentity-ObjektContainerGroupIdentity object

NameName typeType ErforderlichRequired WertValue
typetype enumenum NeinNo Der für die Containergruppe verwendete Identitätstyp.The type of identity used for the container group. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten.The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. Der Typ „None“ entfernt alle Identitäten aus der Containergruppe.The type 'None' will remove any identities from the container group. – SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None- SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
userAssignedIdentitiesuserAssignedIdentities Objekt (object)object NeinNo Die Liste der der Containergruppe zugeordneten Benutzeridentitäten.The list of user identities associated with the container group. Die Schlüsselverweise des Benutzeridentitäts-Wörterbuchs sind Azure Resource Manager-Ressourcen-IDs im Format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.The user identity dictionary key references will be Azure Resource Manager resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ContainerGroupProperties-ObjektContainerGroupProperties object

NameName typeType ErforderlichRequired WertValue
containerscontainers arrayarray JaYes Die Container innerhalb der Containergruppe.The containers within the container group. - Container-Objekt - Container object
imageRegistryCredentialsimageRegistryCredentials arrayarray NeinNo Die Anmeldeinformationen für die Imageregistrierung, mit denen die Containergruppe erstellt wird.The image registry credentials by which the container group is created from. - ImageRegistryCredential-Objekt - ImageRegistryCredential object
restartPolicyrestartPolicy enumenum NeinNo Neustartrichtlinie für alle Container innerhalb der Containergruppe.Restart policy for all containers within the container group. - Always Immer neu starten- OnFailure Neustart bei Fehler- Never Nie neu starten. - Always Always restart- OnFailure Restart on failure- Never Never restart. – Always, OnFailure, Never- Always, OnFailure, Never
ipAddressipAddress Objekt (object)object NeinNo Der IP-Adressentyp der Containergruppe.The IP address type of the container group. - IpAddress-Objekt - IpAddress object
osTypeosType enumenum JaYes Der für die Container in der Containergruppe erforderliche Betriebssystemtyp.The operating system type required by the containers in the container group. – Windows oder Linux- Windows or Linux
volumesvolumes arrayarray NeinNo Die Liste der Volumes, die von Containern in dieser Containergruppe eingebunden werden können.The list of volumes that can be mounted by containers in this container group. - Volume-Objekt - Volume object
Diagnosediagnostics Objekt (object)object NeinNo Die Diagnoseinformationen für eine Containergruppe.The diagnostic information for a container group. - ContainerGroupDiagnostics-Objekt - ContainerGroupDiagnostics object
networkProfilenetworkProfile Objekt (object)object NeinNo Die Netzwerkprofilinformationen für eine Containergruppe.The network profile information for a container group. - ContainerGroupNetworkProfile-Objekt - ContainerGroupNetworkProfile object
dnsConfigdnsConfig Objekt (object)object NeinNo Die DNS-Konfigurationsinformationen für eine Containergruppe.The DNS config information for a container group. - DnsConfiguration-Objekt - DnsConfiguration object
skusku enumenum NeinNo SKU für eine Containergruppe: Standard oder DedicatedThe SKU for a container group - Standard or Dedicated
encryptionPropertiesencryptionProperties Objekt (object)object NeinNo Die Verschlüsselungseigenschaften für eine Containergruppe.The encryption properties for a container group. - EncryptionProperties-Objekt - EncryptionProperties object
initContainersinitContainers arrayarray NeinNo Die Init-Container für eine ContainergruppeThe init containers for a container group. - InitContainerDefinition-Objekt - InitContainerDefinition object

Container-ObjektContainer object

NameName typeType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der vom Benutzer bereitgestellte Name der Containerinstanz.The user-provided name of the container instance.
propertiesproperties Objekt (object)object JaYes Der Eigenschaften der Containerinstanz.The properties of the container instance. - ContainerProperties-Objekt - ContainerProperties object

ImageRegistryCredential-ObjektImageRegistryCredential object

NameName TypType ErforderlichRequired WertValue
serverserver Zeichenfolgestring JaYes Der Docker-Imageregistrierungsserver ohne ein Protokoll wie „HTTP“ oder „HTTPS“.The Docker image registry server without a protocol such as "http" and "https".
usernameusername Zeichenfolgestring JaYes Der Benutzername für die private Registrierung.The username for the private registry.
passwordpassword Zeichenfolgestring NoNo Das Kennwort für die private Registrierung.The password for the private registry.

IpAddress-ObjektIpAddress object

NameName TypType ErforderlichRequired WertValue
portsports arrayarray JaYes Die Liste der in der Containergruppe verfügbar gemachten Ports.The list of ports exposed on the container group. - Port-Objekte - Port object
typetype enumenum JaYes Gibt an, ob die IP dem öffentlichen Internet oder dem privaten VNET verfügbar gemacht ist.Specifies if the IP is exposed to the public internet or private VNET. – Public oder Private- Public or Private
ipip Zeichenfolgestring NoNo Die dem öffentlichen Internet verfügbar gemachte IP-Adresse.The IP exposed to the public internet.
dnsNameLabeldnsNameLabel Zeichenfolgestring NoNo Die DNS-Namensbezeichnung für die IP-Adresse.The Dns name label for the IP.

Volume-ObjektVolume object

NameName TypType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der Name des Volumes.The name of the volume.
azureFileazureFile Objekt (object)object NeinNo Das Azure File-Volume.The Azure File volume. - AzureFileVolume-Objekt - AzureFileVolume object
emptyDiremptyDir Objekt (object)object NeinNo Das leere Verzeichnis-Volume.The empty directory volume.
secretsecret Objekt (object)object NeinNo Das geheime Volume.The secret volume.
gitRepogitRepo Objekt (object)object NeinNo Das Git-Repository-Volume.The git repo volume. - GitRepoVolume-Objekt - GitRepoVolume object

ContainerGroupDiagnostics-ObjektContainerGroupDiagnostics object

NameName TypType ErforderlichRequired WertValue
logAnalyticslogAnalytics Objekt (object)object NeinNo Containergruppen-Protokollanalyseinformationen.Container group log analytics information. - LogAnalytics-Objekt - LogAnalytics object

ContainerGroupNetworkProfile-ObjektContainerGroupNetworkProfile object

NameName TypType ErforderlichRequired WertValue
idid Zeichenfolgestring JaYes Der Bezeichner für ein Netzwerkprofil.The identifier for a network profile.

DnsConfiguration-ObjektDnsConfiguration object

NameName TypType ErforderlichRequired WertValue
nameServersnameServers arrayarray JaYes Die DNS-Server für die Containergruppe.The DNS servers for the container group. – string- string
searchDomainssearchDomains Zeichenfolgestring NoNo Die DNS-Suchdomänen für das Nachschlagen von Hostnamen in der Containergruppe.The DNS search domains for hostname lookup in the container group.
Optionenoptions Zeichenfolgestring NoNo Die DNS-Optionen für die Containergruppe.The DNS options for the container group.

EncryptionProperties-ObjektEncryptionProperties object

NameName TypType ErforderlichRequired WertValue
vaultBaseUrlvaultBaseUrl Zeichenfolgestring JaYes Die Basis-URL für den Schlüsseltresor.The keyvault base url.
keyNamekeyName Zeichenfolgestring JaYes Der Name des VerschlüsselungsschlüsselsThe encryption key name.
keyVersionkeyVersion Zeichenfolgestring JaYes Die Version des VerschlüsselungsschlüsselsThe encryption key version.

InitContainerDefinition-ObjektInitContainerDefinition object

NameName TypType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der Name für den Init-ContainerThe name for the init container.
propertiesproperties Objekt (object)object JaYes Die Eigenschaften für den Init-Container.The properties for the init container. - InitContainerPropertiesDefinition-Objekt - InitContainerPropertiesDefinition object

ContainerProperties-ObjektContainerProperties object

NameName TypType ErforderlichRequired WertValue
imageimage Zeichenfolgestring JaYes Der Name des zum Erstellen der Containerinstanz verwendeten Images.The name of the image used to create the container instance.
commandcommand arrayarray NeinNo Die innerhalb der Containerinstanz auszuführenden Befehle im EXEC-Format.The commands to execute within the container instance in exec form. – string- string
portsports arrayarray NeinNo Die in der Containerinstanz verfügbar gemachten Ports.The exposed ports on the container instance. - ContainerPort-Objekt - ContainerPort object
environmentVariablesenvironmentVariables arrayarray NeinNo Die in der Containerinstanz festzulegenden Umgebungsvariablen.The environment variables to set in the container instance. - EnvironmentVariable-Objekt - EnvironmentVariable object
ressourcenresources Objekt (object)object JaYes Die Ressourcenanforderungen der Containerinstanz.The resource requirements of the container instance. - ResourceRequirements-Objekt - ResourceRequirements object
volumeMountsvolumeMounts arrayarray NeinNo Die für die Containerinstanz verfügbaren Volumebereitstellungen.The volume mounts available to the container instance. - VolumeMount-Objekt - VolumeMount object
livenessProbelivenessProbe Objekt (object)object NeinNo Der Livetest.The liveness probe. - ContainerProbe-Objekt - ContainerProbe object
readinessProbereadinessProbe Objekt (object)object NeinNo Der Bereitschaftstest.The readiness probe. - ContainerProbe-Objekt - ContainerProbe object

Port-ObjektPort object

NameName TypType ErforderlichRequired WertValue
Protokollprotocol enumenum NeinNo Das dem Port zugeordnete Protokoll.The protocol associated with the port. – TCP oder UDP- TCP or UDP
portport integerinteger JaYes Die Portnummer.The port number.

AzureFileVolume-ObjektAzureFileVolume object

NameName TypType ErforderlichRequired WertValue
shareNameshareName Zeichenfolgestring JaYes Der Name der als Volume bereitzustellenden Azure File-Freigabe.The name of the Azure File share to be mounted as a volume.
readOnlyreadOnly booleanboolean NeinNo Das Flag, das anzeigt, ob die als Volume bereitgestellte Azure File-Freigabe schreibgeschützt ist.The flag indicating whether the Azure File shared mounted as a volume is read-only.
storageAccountNamestorageAccountName Zeichenfolgestring JaYes Der Name des Speicherkontos, das die Azure File-Freigabe enthält.The name of the storage account that contains the Azure File share.
storageAccountKeystorageAccountKey Zeichenfolgestring NoNo Der Zugriffsschlüssel des Speicherkontos, der für den Zugriff auf die Azure File-Freigabe verwendet wird.The storage account access key used to access the Azure File share.

GitRepoVolume-ObjektGitRepoVolume object

NameName TypType ErforderlichRequired WertValue
directorydirectory Zeichenfolgestring NoNo Zielverzeichnisname.Target directory name. Darf „..“ weder enthalten noch damit beginnen.Must not contain or start with '..'. Wenn „.“ angegeben wird, ist das Volumeverzeichnis das Git-Repository.If '.' is supplied, the volume directory will be the git repository. Andernfalls, falls angegeben, enthält das Volume das Git-Repository in einem Unterverzeichnis mit dem angegebenen Namen.Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repositoryrepository Zeichenfolgestring JaYes Repository-URLRepository URL
revisionrevision Zeichenfolgestring NeinNo Commit-Hash für die angegebene Revision.Commit hash for the specified revision.

LogAnalytics-ObjektLogAnalytics object

NameName TypType ErforderlichRequired WertValue
workspaceIdworkspaceId Zeichenfolgestring JaYes Die Arbeitsbereichs-ID für Log Analytics.The workspace id for log analytics
workspaceKeyworkspaceKey Zeichenfolgestring JaYes Der Arbeitsbereichsschlüssel für Log Analytics.The workspace key for log analytics
logTypelogType enumenum NeinNo Der zu verwendende Protokolltyp.The log type to be used. – ContainerInsights oder ContainerInstanceLogs- ContainerInsights or ContainerInstanceLogs
metadatametadata Objekt (object)object NeinNo Metadaten für Log Analytics.Metadata for log analytics.

InitContainerPropertiesDefinition-ObjektInitContainerPropertiesDefinition object

NameName TypType ErforderlichRequired WertValue
imageimage Zeichenfolgestring NoNo Das Image des Init-Containers.The image of the init container.
commandcommand arrayarray NeinNo Der Befehl, der im Init-Container im Ausführungsformat ausgeführt werden soll.The command to execute within the init container in exec form. – string- string
environmentVariablesenvironmentVariables arrayarray NeinNo Die Umgebungsvariablen, die im Init-Container festgelegt werden sollen.The environment variables to set in the init container. - EnvironmentVariable-Objekt - EnvironmentVariable object
volumeMountsvolumeMounts arrayarray NeinNo Die für den Init-Container verfügbaren Volumebereitstellungen.The volume mounts available to the init container. - VolumeMount-Objekt - VolumeMount object

ContainerPort-ObjektContainerPort object

NameName TypType ErforderlichRequired WertValue
Protokollprotocol enumenum NeinNo Das dem Port zugeordnete Protokoll.The protocol associated with the port. – TCP oder UDP- TCP or UDP
portport integerinteger JaYes Die innerhalb der Containergruppe verfügbar gemachte Portnummer.The port number exposed within the container group.

EnvironmentVariable-ObjektEnvironmentVariable object

NameName TypType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der Name der Umgebungsvariablen.The name of the environment variable.
valuevalue Zeichenfolgestring NoNo Der Wert der Umgebungsvariablen.The value of the environment variable.
secureValuesecureValue Zeichenfolgestring NoNo Der Wert der sicheren Umgebungsvariablen.The value of the secure environment variable.

ResourceRequirements-ObjektResourceRequirements object

NameName TypType ErforderlichRequired WertValue
requestsrequests Objekt (object)object JaYes Die Ressourcenanforderungen dieser Containerinstanz.The resource requests of this container instance. - ResourceRequests-Objekt - ResourceRequests object
Grenzwertelimits Objekt (object)object NeinNo Die Ressourcenlimits dieser Containerinstanz.The resource limits of this container instance. - ResourceLimits-Objekt - ResourceLimits object

VolumeMount-ObjektVolumeMount object

NameName typeType ErforderlichRequired WertValue
namename Zeichenfolgestring JaYes Der Name der Volumebereitstellung.The name of the volume mount.
mountPathmountPath Zeichenfolgestring JaYes Der Pfad innerhalb des Containers, in dem das Volume bereitgestellt werden soll.The path within the container where the volume should be mounted. Darf keinen Doppelpunkt (:) enthalten.Must not contain colon (:).
readOnlyreadOnly booleanboolean NeinNo Das Flag, das anzeigt, ob die Volumebereitstellung schreibgeschützt ist.The flag indicating whether the volume mount is read-only.

ContainerProbe-ObjektContainerProbe object

NameName typeType ErforderlichRequired WertValue
execexec Objekt (object)object NeinNo Der zu testende Ausführungsbefehl – ContainerExec-ObjektThe execution command to probe - ContainerExec object
httpGethttpGet Objekt (object)object NeinNo Die zu testenden HTTP GET-Einstellungen – ContainerHttpGet-ObjektThe Http Get settings to probe - ContainerHttpGet object
initialDelaySecondsinitialDelaySeconds integerinteger NeinNo Die anfänglichen Verzögerungssekunden.The initial delay seconds.
periodSecondsperiodSeconds integerinteger NeinNo Die Zeitraumsekunden.The period seconds.
failureThresholdfailureThreshold integerinteger NeinNo Der Fehlerschwellenwert.The failure threshold.
successThresholdsuccessThreshold integerinteger NeinNo Der Schwellenwert für erfolgreiche Tests.The success threshold.
timeoutSecondstimeoutSeconds integerinteger NeinNo Die Timeoutsekunden.The timeout seconds.

ResourceRequests-ObjektResourceRequests object

NameName TypType ErforderlichRequired WertValue
memoryInGBmemoryInGB numbernumber JaYes Die Arbeitsspeicheranforderung dieser Containerinstanz in GB.The memory request in GB of this container instance.
cpucpu numbernumber JaYes Die CPU-Anforderungen dieser Containerinstanz.The CPU request of this container instance.
gpugpu Objekt (object)object NeinNo Die GPU-Anforderungen dieser Containerinstanz.The GPU request of this container instance. - GpuResource-Objekt - GpuResource object

ResourceLimits-ObjektResourceLimits object

NameName TypType ErforderlichRequired WertValue
memoryInGBmemoryInGB numbernumber NeinNo Das Arbeitsspeicherlimit dieser Containerinstanz in GB.The memory limit in GB of this container instance.
cpucpu numbernumber NeinNo Das CPU-Limit dieser Containerinstanz.The CPU limit of this container instance.
gpugpu Objekt (object)object NeinNo Das GPU-Limit dieser Containerinstanz.The GPU limit of this container instance. - GpuResource-Objekt - GpuResource object

ContainerExec-ObjektContainerExec object

NameName TypType ErforderlichRequired WertValue
commandcommand arrayarray NeinNo Die innerhalb des Containers auszuführenden Befehle.The commands to execute within the container. – string- string

ContainerHttpGet-ObjektContainerHttpGet object

NameName TypType ErforderlichRequired WertValue
pathpath Zeichenfolgestring NeinNo Der zu testende Pfad.The path to probe.
portport integerinteger JaYes Die zu testende Portnummer.The port number to probe.
schemescheme enumenum NeinNo Das Schema.The scheme. – HTTP oder HTTPS- http or https

GpuResource-ObjektGpuResource object

NameName TypType ErforderlichRequired WertValue
countcount integerinteger JaYes Die Anzahl der GPU-Ressourcen.The count of the GPU resource.
skusku enumenum JaYes Die SKU der GPU-Ressource.The SKU of the GPU resource. – K80, P100, V100- K80, P100, V100

Nächste SchritteNext steps

Weitere Informationen finden Sie im Tutorial Bereitstellen einer Gruppe mit mehreren Containern mithilfe einer YAML-Datei.See the tutorial Deploy a multi-container group using a YAML file.

Beispiele für die Verwendung einer YAML-Datei zum Bereitstellen von Containergruppen in einem virtuellen Netzwerk oder für das Einbinden eines externen Volumes.See examples of using a YAML file to deploy container groups in a virtual network or that mount an external volume.