Azure-docs: Provide complete schema for YAML file format

[darzu]

It's not obvious what properties are supported in the YAML file beyond what the example shows. For example, environment variables are supported but I only know that because I stumbled upon another tutorial that mentioned that. I haven't found any link to a complete reference for this YAML format.

Concretely, I need to specify a DNS name label like I would with the "--dns-name-label" parameter to "az container create". This seems like it should be supported by the YAML format but I can't tell.

---

Document Details

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

• ID: 03e645be-5677-9b0b-049e-4b579a5da1af
• Version Independent ID: 36f94f65-128d-f973-ec19-3f3e11b2a405
• Content: Tutorial - Deploy a multi-container group in Azure Container Instances - YAML
• Content Source: articles/container-instances/container-instances-multi-container-yaml.md
• Service: container-instances
• GitHub Login: @dlepow
• Microsoft Alias: danlep

[mimckitt]

@darzu this is because a yaml file is not isolated to only AKS. So there are resources out there that you can reference to better understand how to structure the yaml file.

I will assign to the author to review and see if we can provide some of those resources in the doc.

In the meantime, I suggest doing an internet search for the yaml format for additional information.

www.yaml.org is a site I have used in the past as well.

[darzu]

@MicahMcKittrick-MSFT I'm not asking about the YAML language format, I'm asking specifically about the schema that is accepted by the "az container create --file" command. It seems to me there should be some link in this tutorial to a reference page that enumerates all the supported properties.

[dlepow]

@darzu - Thanks for your feedback, which echoes feedback we've heard from other customers (for example, issue https://github.com/MicrosoftDocs/azure-docs/issues/34614). We have a documentation work item to address this in the near future. In the meantime, please take a look at the container group/instance properties configurable in the Resource Manager template spec. The template spec should help clarify the hierarchy of properties, which are required or optional, etc.

To your specific question, the DNS name label is a supported property. Example:

apiVersion: '2018-10-01'
location: eastus
name: example
properties:
[...]
  ipAddress:
      type: Public
      ports:
        - port: 80
      dnsNameLabel: mylabel
[...]

I hope this helps!