Référence YAML : Azure Container Instances

Cet article décrit la syntaxe et les propriétés du fichier YAML pris en charge par Azure Container Instances pour configurer un groupe de conteneurs. Utilisez un fichier YAML pour entrer la configuration du groupe dans la commande az container create dans le Azure CLI.

Un fichier YAML est un moyen pratique de configurer un groupe de conteneurs pour les déploiements reproductibles. Il s'agit d'une alternative concise à l'utilisation d'un modèle Resource Manager ou des sdk Azure Container Instances pour créer ou mettre à jour un groupe de conteneurs.

Schema

Le schéma du fichier YAML suit, y compris les commentaires pour mettre en surbrillance les propriétés clés. Pour obtenir une description des propriétés de ce schéma, consultez la section Valeurs de propriété.

name: string  # Name of the container group
apiVersion: '2021-10-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:
          httpHeaders:
          - name: string
            value: string
          path: string
          port: integer
          scheme: string
        initialDelaySeconds: integer
        periodSeconds: integer
        failureThreshold: integer
        successThreshold: integer
        timeoutSeconds: integer
      readinessProbe:
        exec:
          command:
          - string
        httpGet:
          httpHeaders:
          - name: string
            value: string
          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
    identity: string
    identityUrl: string
  restartPolicy: string
  ipAddress: # IP address configuration of container group
    ports:
    - protocol: string
      port: integer
    type: string
    ip: string
    dnsNameLabel: string
    autoGeneratedDomainNameLabelScope: 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
      workspaceResourceId: string
      logType: string
      metadata: {}
  subnetIds: # Subnet to deploy the container group into
    - id: string
      name: 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

Valeurs de propriété

Les tableaux suivants décrivent les valeurs que vous devez définir dans le schéma.

Microsoft. Objet ContainerInstance/containerGroups

ContainerGroupIdentity (objet)

ContainerGroupProperties (objet)

Container, objet

Objet ImageRegistryCredential

Objet IpAddress

Objet Volume

ContainerGroupDiagnostics (objet)

ContainerGroupSubnetIds (objet)

Objet DnsConfiguration

Objet EncryptionProperties

Objet InitContainerDefinition

Objet ContainerProperties

Objet Port

Objet AzureFileVolume

Objet GitRepoVolume

Objet LogAnalytics

Objet InitContainerPropertiesDefinition

ContainerPort (objet)

Objet EnvironmentVariable

ResourceRequirements (objet)

Objet VolumeMount

ContainerProbe (objet)

Objet ResourceRequests

Objet ResourceLimits

ContainerExec (objet)

ContainerHttpGet (objet)

Objet HttpHeaders

Objet GpuResource

Étapes suivantes

Consultez le tutoriel Déployer un groupe à plusieurs conteneurs à l’aide d’un fichier YAML.

Consultez des exemples d’utilisation d’un fichier YAML pour déployer des groupes de conteneurs dans un réseau virtuel ou qui montent un volume externe.