Referência de YAML: Instâncias de Contêiner do Azure

Este artigo aborda a sintaxe e as propriedades do arquivo YAML usado com as Instâncias de Contêiner do Azure para configurar um grupo de contêineres. Use um arquivo YAML para inserir a configuração do grupo no comando az container create da CLI do Azure.

Um arquivo YAML é uma forma conveniente de configurar um grupo de contêineres para implantações reproduzíveis. É uma alternativa concisa ao uso de modelos do Resource Manager ou de SDKs das Instâncias de Contêiner do Azure para criar ou atualizar um grupo de contêineres.

Esquema

Veja abaixo o esquema do arquivo YAML, incluindo comentários para realçar as principais propriedades. A descrição das propriedades do esquema está disponível na seção Valores de propriedade.

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 propriedade

As tabelas a seguir descrevem os valores necessários para definir no esquema.

Objeto 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 InitContainerPropertiesDefinition

Objeto ContainerPort

Objeto EnvironmentVariable

Objeto ResourceRequirements

Objeto VolumeMount

Objeto ContainerProbe

Objeto ResourceRequests

Objeto ResourceLimits

Objeto ContainerExec

Objeto ContainerHttpGet

Objeto HttpHeaders

Objeto GpuResource

Próximas etapas

Confira o tutorial Implantar um grupo com vários contêineres usando um arquivo YAML.

Veja exemplos de como usar um arquivo YAML para implantar grupos de contêineres em uma rede virtual ou que montam um volume externo.