Merge pull request #1532 from Azure/antmarti/add_metadata

Add metadata field to JSON schema
Azure · Mar 2, 2021 · 5b8ce6d · 5b8ce6d
2 parents ec60385 + dad3f5a
commit 5b8ce6d
Show file tree

Hide file tree

Showing 21 changed files with 96 additions and 0 deletions.
diff --git a/schemas/2014-04-01-preview/deploymentTemplate.json b/schemas/2014-04-01-preview/deploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "contentVersion": {
       "type": "string",
       "pattern": "(^[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+$)",

diff --git a/schemas/2015-01-01/deploymentTemplate.json b/schemas/2015-01-01/deploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "apiProfile": {
       "type": "string",
       "enum": [

diff --git a/schemas/2018-05-01/subscriptionDeploymentTemplate.json b/schemas/2018-05-01/subscriptionDeploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "apiProfile": {
       "type": "string",
       "enum": [

diff --git a/schemas/2019-03-01-hybrid/deploymentTemplate.json b/schemas/2019-03-01-hybrid/deploymentTemplate.json
@@ -11,6 +11,11 @@
           "type": "string",
           "description": "JSON schema reference"
         },
+        "metadata": {
+          "type": "object",
+          "description": "Additional unstructured metadata to include with the template deployment.",
+          "additionalProperties": true
+        },
         "contentVersion": {
           "type": "string",
           "pattern": "(^[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+$)",
@@ -126,6 +131,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "contentVersion": {
       "type": "string",
       "pattern": "(^[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+$)",

diff --git a/schemas/2019-04-01/deploymentTemplate.json b/schemas/2019-04-01/deploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "apiProfile": {
       "type": "string",
       "enum": [

diff --git a/schemas/2019-08-01/managementGroupDeploymentTemplate.json b/schemas/2019-08-01/managementGroupDeploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "apiProfile": {
       "type": "string",
       "enum": [

diff --git a/schemas/2019-08-01/tenantDeploymentTemplate.json b/schemas/2019-08-01/tenantDeploymentTemplate.json
@@ -9,6 +9,11 @@
       "type": "string",
       "description": "JSON schema reference"
     },
+    "metadata": {
+      "type": "object",
+      "description": "Additional unstructured metadata to include with the template deployment.",
+      "additionalProperties": true
+    },
     "apiProfile": {
       "type": "string",
       "enum": [

diff --git a/tools/templateTests/ManagementGroupTemplate.2019-08-01.json b/tools/templateTests/ManagementGroupTemplate.2019-08-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {

diff --git a/tools/templateTests/SubscriptionTemplate.2018-05-01.json b/tools/templateTests/SubscriptionTemplate.2018-05-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {

diff --git a/tools/templateTests/Template_1.2014-01-01-preview.json b/tools/templateTests/Template_1.2014-01-01-preview.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {

diff --git a/tools/templateTests/Template_1.2015-01-01.json b/tools/templateTests/Template_1.2015-01-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {

diff --git a/tools/templateTests/Template_1.2019-03-01-hybrid.json b/tools/templateTests/Template_1.2019-03-01-hybrid.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-03-01-hybrid/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "keyvaultSettings": {

diff --git a/tools/templateTests/Template_1.2019-04-01.json b/tools/templateTests/Template_1.2019-04-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {

diff --git a/tools/templateTests/Template_2.2014-01-01-preview.json b/tools/templateTests/Template_2.2014-01-01-preview.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "name": {

diff --git a/tools/templateTests/Template_2.2015-01-01.json b/tools/templateTests/Template_2.2015-01-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "name": {

diff --git a/tools/templateTests/Template_2.2019-03-01-hybrid.json b/tools/templateTests/Template_2.2019-03-01-hybrid.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-03-01-hybrid/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {},
   "variables": {},

diff --git a/tools/templateTests/Template_2.2019-04-01.json b/tools/templateTests/Template_2.2019-04-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "name": {

diff --git a/tools/templateTests/Template_3.2015-01-01.json b/tools/templateTests/Template_3.2015-01-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "virtualNetworkName": {

diff --git a/tools/templateTests/Template_3.2019-03-01-hybrid.json b/tools/templateTests/Template_3.2019-03-01-hybrid.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-03-01-hybrid/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "adminUsername": {

diff --git a/tools/templateTests/Template_3.2019-04-01.json b/tools/templateTests/Template_3.2019-04-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "virtualNetworkName": {

diff --git a/tools/templateTests/TenantTemplate.2019-08-01.json b/tools/templateTests/TenantTemplate.2019-08-01.json
@@ -1,5 +1,9 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-08-01/tenantDeploymentTemplate.json#",
+  "metadata": {
+    "comments": "This template was developed for schema validation purposes.",
+    "author": "Azure Deployments"
+  },
   "contentVersion": "1.0.0.0",
   "parameters": {
     "siteName": {