Azure-docs: YAML File Configuration Parameters/Properties

Created on 9 Aug 2018  Â·  2Comments  Â·  Source: MicrosoftDocs/azure-docs

What is the list of acceptable parameters/configuration properties that can be included in the YAML file.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

assigned-to-author container-instancesvc product-question triaged

Most helpful comment

@lqdev Hi Luis, although we don't yet have the YAML reference published, it supports the same properties and parameter values as the Resource Management template:

Microsoft.ContainerInstance/containerGroups template reference

The YAML template reference is currently on our backlog of articles to publish. In the meantime, here's a quick JSON-to-YAML conversion of the template, and you can use the above article for reference on the properties within the template.

---
name: string
type: Microsoft.ContainerInstance/containerGroups
apiVersion: '2018-06-01'
location: string
tags: {}
properties:
  containers:
  - name: string
    properties:
      image: string
      command:
      - string
      ports:
      - protocol: string
        port: integer
      environmentVariables:
      - name: string
        value: string
        secureValue: string
      resources:
        requests:
          memoryInGB: number
          cpu: number
        limits:
          memoryInGB: number
          cpu: number
      volumeMounts:
      - 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:
  - server: string
    username: string
    password: string
  restartPolicy: string
  ipAddress:
    ports:
    - protocol: string
      port: integer
    type: Public
    ip: string
    dnsNameLabel: string
  osType: string
  volumes:
  - 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

All 2 comments

@lqdev Hi Luis, although we don't yet have the YAML reference published, it supports the same properties and parameter values as the Resource Management template:

Microsoft.ContainerInstance/containerGroups template reference

The YAML template reference is currently on our backlog of articles to publish. In the meantime, here's a quick JSON-to-YAML conversion of the template, and you can use the above article for reference on the properties within the template.

---
name: string
type: Microsoft.ContainerInstance/containerGroups
apiVersion: '2018-06-01'
location: string
tags: {}
properties:
  containers:
  - name: string
    properties:
      image: string
      command:
      - string
      ports:
      - protocol: string
        port: integer
      environmentVariables:
      - name: string
        value: string
        secureValue: string
      resources:
        requests:
          memoryInGB: number
          cpu: number
        limits:
          memoryInGB: number
          cpu: number
      volumeMounts:
      - 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:
  - server: string
    username: string
    password: string
  restartPolicy: string
  ipAddress:
    ports:
    - protocol: string
      port: integer
    type: Public
    ip: string
    dnsNameLabel: string
  osType: string
  volumes:
  - 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

@mmacy Thanks Marsh! That helps.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Agazoth picture Agazoth  Â·  3Comments

monteledwards picture monteledwards  Â·  3Comments

AronT-TLV picture AronT-TLV  Â·  3Comments

JamesDLD picture JamesDLD  Â·  3Comments

jharbieh picture jharbieh  Â·  3Comments