Referencia de YAML: Azure Container Instances

En este artículo se describen la sintaxis y las propiedades del archivo YAML admitido por Azure Container Instances para configurar un grupo de contenedores. Use un archivo YAML para introducir la configuración del grupo en el comando az container create en el CLI de Azure.

Un archivo YAML es una manera cómoda de configurar un grupo de contenedores para implementaciones reproducibles. Es una alternativa concisa al uso de una plantilla de Resource Manager o los SDK de Azure Container Instances para crear o actualizar un grupo de contenedores.

Schema

El esquema del archivo YAML sigue, incluidos los comentarios para resaltar las propiedades clave. Para obtener una descripción de las propiedades de este esquema, vea la sección Valores de propiedad.

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

Valores de propiedades

En las tablas siguientes se describen los valores que debe establecer en el esquema.

Microsoft. ContainerInstance/containerGroups (objeto)

ContainerGroupIdentity (objeto)

ContainerGroupProperties (objeto)

Container (objeto)

ImageRegistryCredential (objeto)

IpAddress (objeto)

Volume (objeto)

ContainerGroupDiagnostics (objeto)

ContainerGroupSubnetIds (objeto)

DnsConfiguration (objeto)

EncryptionProperties (objeto)

InitContainerDefinition (objeto)

ContainerProperties (objeto)

Port (objeto)

AzureFileVolume (objeto)

GitRepoVolume (objeto)

LogAnalytics (objeto)

Objeto InitContainerPropertiesDefinition

ContainerPort (objeto)

EnvironmentVariable (objeto)

ResourceRequirements (objeto)

VolumeMount (objeto)

ContainerProbe (objeto)

ResourceRequests (objeto)

ResourceLimits (objeto)

ContainerExec (objeto)

ContainerHttpGet (objeto)

HttpHeaders (objeto)

Objeto GpuResource

Pasos siguientes

Consulte el tutorial Implementación de un grupo de varios contenedores mediante un archivo YAML.

Vea ejemplos de uso de un archivo YAML para implementar grupos de contenedores en una red virtual o que monten un volumen externo.