search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.31k stars 21.48k forks source link

Page needs further object specifications #84796

Closed larryclaman closed 2 years ago

larryclaman commented 2 years ago

This page provides an example of a YAML template, but it doesn't look like the YAML specification is documented. Please provide the full speciation.

Example of what I mean: on this page, under properties.template, it lists the containers property as an object data type. Great, but where's the detail of that object; eg what are the properties of containers object? etc.

I totally get that that this service is early preview, but I need to be able to understand the API before I can start experimenting with it.

Document Details

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

himanshusinha-msft commented 2 years ago

We have assigned the issue to the content author . They will evaluate & update the document as appropriate

cebundy commented 2 years ago

This doc has been updated. It shows an example of the properties.template section of the ARM template with the parameters. There is also information in the Containers article.

please-close

larryclaman commented 2 years ago

@cebundy, I don't think this answered my question. Yes, there are examples of the properties.template, but there's no specification. Here's an example of what I mean:

At https://docs.microsoft.com/en-us/azure/container-apps/azure-resource-manager-api-spec?tabs=yaml#propertiestemplate, under *scale8, it says "Configuration object that defines scale rules for the container app.". Ok, great. But then in the example section it shows:

    scale:
      minReplicas: 1
      maxReplicas: 3

Where are the minReplicas and maxReplicas defined? What are their limits? Are these the ONLY subproperties to scale, or are there others? etc.

Note that I'm just using scale as an example; what I really want to see is a specification for ALL properties and sub properties.

please-reopen