YAML リファレンス: Azure Container Instances

この記事では、コンテナー グループを構成するためにAzure Container Instancesでサポートされる YAML ファイルの構文とプロパティについて説明します。 YAML ファイルを使用して、Azure CLIの az container create コマンドにグループ構成を入力します。

YAML ファイルは、再現可能なデプロイ用にコンテナー グループを構成する便利な方法です。 これは、Resource Manager テンプレートまたはAzure Container Instances SDK を使用してコンテナー グループを作成または更新する簡潔な代替手段です。

Schema

YAML ファイルのスキーマは、主なプロパティを強調表示するためのコメントを含め、次のとおりです。 このスキーマのプロパティの説明については、「 プロパティ値」 セクションを参照してください。

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

プロパティ値

次の表では、スキーマで設定する必要がある値について説明します。

Microsoft。ContainerInstance/containerGroups オブジェクト

ContainerGroupIdentity オブジェクト

ContainerGroupProperties オブジェクト

Container オブジェクト

ImageRegistryCredential オブジェクト

IpAddress オブジェクト

Volume オブジェクト

ContainerGroupDiagnostics オブジェクト

ContainerGroupSubnetIds オブジェクト

DnsConfiguration オブジェクト

EncryptionProperties オブジェクト

InitContainerDefinition オブジェクト

ContainerProperties オブジェクト

Port オブジェクト

AzureFileVolume オブジェクト

GitRepoVolume オブジェクト

LogAnalytics オブジェクト

InitContainerPropertiesDefinition オブジェクト

ContainerPort オブジェクト

EnvironmentVariable オブジェクト

ResourceRequirements オブジェクト

VolumeMount オブジェクト

ContainerProbe オブジェクト

ResourceRequests オブジェクト

ResourceLimits オブジェクト

ContainerExec オブジェクト

ContainerHttpGet オブジェクト

HttpHeaders オブジェクト

GpuResource オブジェクト

次のステップ

チュートリアル「YAML ファイルを使用して複数コンテナー グループをデプロイする」を参照してください。

YAML ファイルを使用して 、仮想ネットワーク または 外部ボリュームをマウントするコンテナー グループをデプロイする例を参照してください。