metadata.schema.json

{
  "properties": {
    "$schema": {
      "type": "string",
      "enum": [
        "https://aka.ms/azure-quickstart-templates-metadata-schema#"
      ],
      "description": "JSON schema reference"
    },
    "itemDisplayName": {
      "type": "string",
      "minLength": 10,
      "maxLength": 60
    },
    "description": {
      "type": "string",
      "minLength": 10,
      "maxLength": 1000
    },
    "summary": {
      "type": "string",
      "minLength": 10,
      "maxLength": 200
    },
    "githubUsername": {
      "type": "string",
      "pattern": "^[a-zA-Z\\d](?:[a-zA-Z\\d]|-(?=[a-zA-Z\\d])){0,38}$"
    },
    "docOwner": {
      "type": "string",
      "pattern": "^[a-zA-Z\\d](?:[a-zA-Z\\d]|-(?=[a-zA-Z\\d])){0,38}$"
    },
    "dateUpdated": {
      "type": "string",
      "pattern": "^(20[1-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
    },
    "validationType": {
      "type": "string",
      "enum": [
        "Manual",
        "Automated"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "QuickStart",
        "Application",
        "ManagedApplication",
        "Module",
        "PolicyDefinition",
        "Prereq",
        "SubscriptionDeployment",
        "ManagementGroupDeployment",
        "TenantDeployment"
      ]
    },
    "icon": {
      "type": "string",
      "enum": [
        "api",
        "blankTemplate",
        "cdnStorage",
        "cdnWebsite",
        "docker",
        "documentDB",
        "logic",
        "serviceFabric",
        "ubuntu",
        "vmss",
        "windowsVM"
      ]
    },
    "tags": {
      "type": "object",
      "additionalProperties": true,
      "description": "Collection of tags or keywords for the sample"
    },
    "environments": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "AzureUSGovernment",
          "AzureCloud",
          "AzureGermanCloud",
          "AzureChinaCloud"
        ]
      },
      "additionalItems": false,
      "additionalProperties": false
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "json",
          "bicep",
          "terraform"
        ]
      },
      "additionalItems": false,
      "additionalProperties": false
    }
  },
  "required": [
    "$schema",
    "itemDisplayName",
    "description",
    "summary",
    "githubUsername",
    "dateUpdated",
    "type"
  ],
  "additionalProperties": false
}