Microsoft.Resources (stable:2024-11-01)

2025/01/28 • 5 updated methods

Deployments_ValidateAtScope (updated)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_ValidateAtScope",
  "$responses": {
    "200": {
      "Description": {
        "new": "Information from validate template deployment response.",
        "old": "Deployment information."
      },
      "$properties": [
        {
          "@added_df0e4f4a156a4aa1a1797c37a2b382ba": {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "The template deployment properties.",
            "old": "Deployment properties."
          }
        },
        {
          "@removed_054bc53dd1374fdd880059f2ff68d848": {
            "#name": "location",
            "Description": "the location of the deployment.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_d18ea4bf392843cfbdda1825b0957239": {
            "#name": "tags",
            "Description": "Deployment tags",
            "Required": false,
            "Type": "object"
          }
        }
      ]
    },
    "@added_c7cc9cc19ab84b06937a683f43a3dfa9": {
      "400": {
        "Description": "Information from validate template deployment response.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "id",
            "Description": "The ID of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "type",
            "Description": "The type of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "The template deployment properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "provisioningState",
                "Description": "Denotes the state of provisioning.",
                "Enum": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Running",
                    ""
                  ],
                  [
                    "Ready",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Created",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "correlationId",
                "Description": "The correlation ID of the deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "timestamp",
                "Description": "The timestamp of the template deployment.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "duration",
                "Description": "The duration of the template deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputs",
                "Description": "Key/value pairs that represent deployment output.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "providers",
                "Description": "The list of resource providers needed for the deployment.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Resource provider information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The provider ID.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "namespace",
                      "Description": "The namespace of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationState",
                      "Description": "The registration state of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationPolicy",
                      "Description": "The registration policy of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceTypes",
                      "Description": "The collection of provider resource types.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Resource type managed by the resource provider.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceType",
                            "Description": "The resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "locations",
                            "Description": "The collection of locations where this resource type can be created.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "locationMappings",
                            "Description": "The location mappings that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The provider extended location. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The azure location.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The extended location type.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "extendedLocations",
                                  "Description": "The extended locations for the azure location.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "aliases",
                            "Description": "The aliases that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The alias type. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": "The alias name.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "paths",
                                  "Description": "The paths for an alias.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Description": "The type of the paths for alias.",
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "path",
                                        "Description": "The path of an alias.",
                                        "Required": false,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "apiVersions",
                                        "Description": "The API versions.",
                                        "Required": false,
                                        "Type": "array",
                                        "$items": {
                                          "Type": "string"
                                        }
                                      },
                                      {
                                        "#name": "pattern",
                                        "Description": "The pattern for an alias path.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "phrase",
                                            "Description": "The alias pattern phrase.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "variable",
                                            "Description": "The alias pattern variable.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "type",
                                            "Description": "The type of alias pattern",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "NotSpecified is not allowed."
                                              ],
                                              [
                                                "Extract",
                                                "Extract is the only allowed value."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      },
                                      {
                                        "#name": "metadata",
                                        "Description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": "The type of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "The token type is not specified."
                                              ],
                                              [
                                                "Any",
                                                "The token type can be anything."
                                              ],
                                              [
                                                "String",
                                                "The token type is string."
                                              ],
                                              [
                                                "Object",
                                                "The token type is object."
                                              ],
                                              [
                                                "Array",
                                                "The token type is array."
                                              ],
                                              [
                                                "Integer",
                                                "The token type is integer."
                                              ],
                                              [
                                                "Number",
                                                "The token type is number."
                                              ],
                                              [
                                                "Boolean",
                                                "The token type is boolean."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "attributes",
                                            "Description": "The attributes of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "None",
                                                "The token that the alias path is referring to has no attributes."
                                              ],
                                              [
                                                "Modifiable",
                                                "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                },
                                {
                                  "#name": "type",
                                  "Description": "The type of the alias.",
                                  "Enum": [
                                    [
                                      "NotSpecified",
                                      "Alias type is unknown (same as not providing alias type)."
                                    ],
                                    [
                                      "PlainText",
                                      "Alias value is not secret."
                                    ],
                                    [
                                      "Mask",
                                      "Alias value is secret."
                                    ]
                                  ],
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPath",
                                  "Description": "The default path for an alias.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPattern",
                                  "Description": "The default pattern for an alias.",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "phrase",
                                      "Description": "The alias pattern phrase.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "variable",
                                      "Description": "The alias pattern variable.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "type",
                                      "Description": "The type of alias pattern",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "NotSpecified is not allowed."
                                        ],
                                        [
                                          "Extract",
                                          "Extract is the only allowed value."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                },
                                {
                                  "#name": "defaultMetadata",
                                  "Description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": "The type of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "The token type is not specified."
                                        ],
                                        [
                                          "Any",
                                          "The token type can be anything."
                                        ],
                                        [
                                          "String",
                                          "The token type is string."
                                        ],
                                        [
                                          "Object",
                                          "The token type is object."
                                        ],
                                        [
                                          "Array",
                                          "The token type is array."
                                        ],
                                        [
                                          "Integer",
                                          "The token type is integer."
                                        ],
                                        [
                                          "Number",
                                          "The token type is number."
                                        ],
                                        [
                                          "Boolean",
                                          "The token type is boolean."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "attributes",
                                      "Description": "The attributes of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "None",
                                          "The token that the alias path is referring to has no attributes."
                                        ],
                                        [
                                          "Modifiable",
                                          "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiVersions",
                            "Description": "The API version.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultApiVersion",
                            "Description": "The default API version.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "zoneMappings",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The location of the zone mapping.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "zones",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiProfiles",
                            "Description": "The API profiles for the resource provider.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "profileVersion",
                                  "Description": "The profile version.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "apiVersion",
                                  "Description": "The API version.",
                                  "Required": false,
                                  "Type": "string"
                                }
                              ]
                            }
                          },
                          {
                            "#name": "capabilities",
                            "Description": "The additional capabilities offered by this resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "properties",
                            "Description": "The properties.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "providerAuthorizationConsentState",
                      "Description": "The provider authorization consent state.",
                      "Enum": [
                        [
                          "NotSpecified",
                          ""
                        ],
                        [
                          "Required",
                          ""
                        ],
                        [
                          "NotRequired",
                          ""
                        ],
                        [
                          "Consented",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "dependencies",
                "Description": "The list of deployment dependencies.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Deployment dependency information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "dependsOn",
                      "Description": "The list of dependencies.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Deployment dependency information.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "id",
                            "Description": "The ID of the dependency.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceType",
                            "Description": "The dependency resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceName",
                            "Description": "The dependency resource name.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "id",
                      "Description": "The ID of the dependency.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceType",
                      "Description": "The dependency resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceName",
                      "Description": "The dependency resource name.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "templateLink",
                "Description": "The URI referencing the template.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the template to deploy. Use either the uri or id property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "id",
                    "Description": "The resource id of a Template Spec. Use either the id or uri property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "relativePath",
                    "Description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "queryString",
                    "Description": "The query string (for example, a SAS token) to be used with the templateLink URI.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "parameters",
                "Description": "Deployment parameters. ",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "parametersLink",
                "Description": "The URI referencing the parameters. ",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the parameters file.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "mode",
                "Description": "The deployment mode. Possible values are Incremental and Complete.",
                "Enum": [
                  [
                    "Incremental",
                    ""
                  ],
                  [
                    "Complete",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "debugSetting",
                "Description": "The debug setting of the deployment.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "detailLevel",
                    "Description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "onErrorDeployment",
                "Description": "The deployment on error behavior.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": "The state of the provisioning for the on error deployment.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
                    "Enum": [
                      [
                        "LastSuccessful",
                        ""
                      ],
                      [
                        "SpecificDeployment",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "The deployment to be used on error case.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "templateHash",
                "Description": "The hash produced for the template.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputResources",
                "Description": "Array of provisioned resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of provisioned resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "validatedResources",
                "Description": "Array of validated resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of validated resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "error",
                "Description": "The deployment error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "The error code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "The error message.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The error target.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "The error details.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "code",
                          "Description": "The error code.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "message",
                          "Description": "The error message.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "target",
                          "Description": "The error target.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "details",
                          "Description": "The error details.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        },
                        {
                          "#name": "additionalInfo",
                          "Description": "The error additional info.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The resource management error additional info.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": "The additional info type.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "info",
                                "Description": "The additional info.",
                                "Required": false,
                                "Type": "object"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "The error additional info.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The resource management error additional info.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The additional info type.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional info.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "diagnostics",
                "Description": "Contains diagnostic information collected during validation process.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "level",
                      "Description": "Denotes the additional response level.",
                      "Enum": [
                        [
                          "Warning",
                          ""
                        ],
                        [
                          "Info",
                          ""
                        ],
                        [
                          "Error",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "validationLevel",
                "Description": "The validation level of the deployment",
                "Enum": [
                  [
                    "Template",
                    "Static analysis of the template is performed."
                  ],
                  [
                    "Provider",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource."
                  ],
                  [
                    "ProviderNoRbac",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtTenantScope (updated)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_ValidateAtTenantScope",
  "$responses": {
    "200": {
      "Description": {
        "new": "Information from validate template deployment response.",
        "old": "Deployment information."
      },
      "$properties": [
        {
          "@added_a7641f8398a34c689ec343c1e69200d7": {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "The template deployment properties.",
            "old": "Deployment properties."
          }
        },
        {
          "@removed_3582715376aa4794a2cdae1fd90cc036": {
            "#name": "location",
            "Description": "the location of the deployment.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_6ce8d84bc2724b2789bc7f470f04f6f2": {
            "#name": "tags",
            "Description": "Deployment tags",
            "Required": false,
            "Type": "object"
          }
        }
      ]
    },
    "@added_efa79cd59748451a9e75c04654db37aa": {
      "400": {
        "Description": "Information from validate template deployment response.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "id",
            "Description": "The ID of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "type",
            "Description": "The type of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "The template deployment properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "provisioningState",
                "Description": "Denotes the state of provisioning.",
                "Enum": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Running",
                    ""
                  ],
                  [
                    "Ready",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Created",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "correlationId",
                "Description": "The correlation ID of the deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "timestamp",
                "Description": "The timestamp of the template deployment.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "duration",
                "Description": "The duration of the template deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputs",
                "Description": "Key/value pairs that represent deployment output.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "providers",
                "Description": "The list of resource providers needed for the deployment.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Resource provider information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The provider ID.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "namespace",
                      "Description": "The namespace of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationState",
                      "Description": "The registration state of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationPolicy",
                      "Description": "The registration policy of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceTypes",
                      "Description": "The collection of provider resource types.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Resource type managed by the resource provider.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceType",
                            "Description": "The resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "locations",
                            "Description": "The collection of locations where this resource type can be created.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "locationMappings",
                            "Description": "The location mappings that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The provider extended location. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The azure location.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The extended location type.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "extendedLocations",
                                  "Description": "The extended locations for the azure location.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "aliases",
                            "Description": "The aliases that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The alias type. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": "The alias name.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "paths",
                                  "Description": "The paths for an alias.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Description": "The type of the paths for alias.",
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "path",
                                        "Description": "The path of an alias.",
                                        "Required": false,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "apiVersions",
                                        "Description": "The API versions.",
                                        "Required": false,
                                        "Type": "array",
                                        "$items": {
                                          "Type": "string"
                                        }
                                      },
                                      {
                                        "#name": "pattern",
                                        "Description": "The pattern for an alias path.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "phrase",
                                            "Description": "The alias pattern phrase.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "variable",
                                            "Description": "The alias pattern variable.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "type",
                                            "Description": "The type of alias pattern",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "NotSpecified is not allowed."
                                              ],
                                              [
                                                "Extract",
                                                "Extract is the only allowed value."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      },
                                      {
                                        "#name": "metadata",
                                        "Description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": "The type of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "The token type is not specified."
                                              ],
                                              [
                                                "Any",
                                                "The token type can be anything."
                                              ],
                                              [
                                                "String",
                                                "The token type is string."
                                              ],
                                              [
                                                "Object",
                                                "The token type is object."
                                              ],
                                              [
                                                "Array",
                                                "The token type is array."
                                              ],
                                              [
                                                "Integer",
                                                "The token type is integer."
                                              ],
                                              [
                                                "Number",
                                                "The token type is number."
                                              ],
                                              [
                                                "Boolean",
                                                "The token type is boolean."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "attributes",
                                            "Description": "The attributes of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "None",
                                                "The token that the alias path is referring to has no attributes."
                                              ],
                                              [
                                                "Modifiable",
                                                "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                },
                                {
                                  "#name": "type",
                                  "Description": "The type of the alias.",
                                  "Enum": [
                                    [
                                      "NotSpecified",
                                      "Alias type is unknown (same as not providing alias type)."
                                    ],
                                    [
                                      "PlainText",
                                      "Alias value is not secret."
                                    ],
                                    [
                                      "Mask",
                                      "Alias value is secret."
                                    ]
                                  ],
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPath",
                                  "Description": "The default path for an alias.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPattern",
                                  "Description": "The default pattern for an alias.",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "phrase",
                                      "Description": "The alias pattern phrase.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "variable",
                                      "Description": "The alias pattern variable.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "type",
                                      "Description": "The type of alias pattern",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "NotSpecified is not allowed."
                                        ],
                                        [
                                          "Extract",
                                          "Extract is the only allowed value."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                },
                                {
                                  "#name": "defaultMetadata",
                                  "Description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": "The type of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "The token type is not specified."
                                        ],
                                        [
                                          "Any",
                                          "The token type can be anything."
                                        ],
                                        [
                                          "String",
                                          "The token type is string."
                                        ],
                                        [
                                          "Object",
                                          "The token type is object."
                                        ],
                                        [
                                          "Array",
                                          "The token type is array."
                                        ],
                                        [
                                          "Integer",
                                          "The token type is integer."
                                        ],
                                        [
                                          "Number",
                                          "The token type is number."
                                        ],
                                        [
                                          "Boolean",
                                          "The token type is boolean."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "attributes",
                                      "Description": "The attributes of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "None",
                                          "The token that the alias path is referring to has no attributes."
                                        ],
                                        [
                                          "Modifiable",
                                          "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiVersions",
                            "Description": "The API version.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultApiVersion",
                            "Description": "The default API version.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "zoneMappings",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The location of the zone mapping.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "zones",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiProfiles",
                            "Description": "The API profiles for the resource provider.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "profileVersion",
                                  "Description": "The profile version.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "apiVersion",
                                  "Description": "The API version.",
                                  "Required": false,
                                  "Type": "string"
                                }
                              ]
                            }
                          },
                          {
                            "#name": "capabilities",
                            "Description": "The additional capabilities offered by this resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "properties",
                            "Description": "The properties.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "providerAuthorizationConsentState",
                      "Description": "The provider authorization consent state.",
                      "Enum": [
                        [
                          "NotSpecified",
                          ""
                        ],
                        [
                          "Required",
                          ""
                        ],
                        [
                          "NotRequired",
                          ""
                        ],
                        [
                          "Consented",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "dependencies",
                "Description": "The list of deployment dependencies.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Deployment dependency information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "dependsOn",
                      "Description": "The list of dependencies.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Deployment dependency information.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "id",
                            "Description": "The ID of the dependency.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceType",
                            "Description": "The dependency resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceName",
                            "Description": "The dependency resource name.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "id",
                      "Description": "The ID of the dependency.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceType",
                      "Description": "The dependency resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceName",
                      "Description": "The dependency resource name.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "templateLink",
                "Description": "The URI referencing the template.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the template to deploy. Use either the uri or id property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "id",
                    "Description": "The resource id of a Template Spec. Use either the id or uri property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "relativePath",
                    "Description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "queryString",
                    "Description": "The query string (for example, a SAS token) to be used with the templateLink URI.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "parameters",
                "Description": "Deployment parameters. ",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "parametersLink",
                "Description": "The URI referencing the parameters. ",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the parameters file.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "mode",
                "Description": "The deployment mode. Possible values are Incremental and Complete.",
                "Enum": [
                  [
                    "Incremental",
                    ""
                  ],
                  [
                    "Complete",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "debugSetting",
                "Description": "The debug setting of the deployment.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "detailLevel",
                    "Description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "onErrorDeployment",
                "Description": "The deployment on error behavior.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": "The state of the provisioning for the on error deployment.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
                    "Enum": [
                      [
                        "LastSuccessful",
                        ""
                      ],
                      [
                        "SpecificDeployment",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "The deployment to be used on error case.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "templateHash",
                "Description": "The hash produced for the template.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputResources",
                "Description": "Array of provisioned resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of provisioned resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "validatedResources",
                "Description": "Array of validated resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of validated resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "error",
                "Description": "The deployment error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "The error code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "The error message.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The error target.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "The error details.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "code",
                          "Description": "The error code.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "message",
                          "Description": "The error message.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "target",
                          "Description": "The error target.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "details",
                          "Description": "The error details.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        },
                        {
                          "#name": "additionalInfo",
                          "Description": "The error additional info.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The resource management error additional info.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": "The additional info type.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "info",
                                "Description": "The additional info.",
                                "Required": false,
                                "Type": "object"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "The error additional info.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The resource management error additional info.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The additional info type.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional info.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "diagnostics",
                "Description": "Contains diagnostic information collected during validation process.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "level",
                      "Description": "Denotes the additional response level.",
                      "Enum": [
                        [
                          "Warning",
                          ""
                        ],
                        [
                          "Info",
                          ""
                        ],
                        [
                          "Error",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "validationLevel",
                "Description": "The validation level of the deployment",
                "Enum": [
                  [
                    "Template",
                    "Static analysis of the template is performed."
                  ],
                  [
                    "Provider",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource."
                  ],
                  [
                    "ProviderNoRbac",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtManagementGroupScope (updated)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_ValidateAtManagementGroupScope",
  "$responses": {
    "200": {
      "Description": {
        "new": "Information from validate template deployment response.",
        "old": "Deployment information."
      },
      "$properties": [
        {
          "@added_6c1c9cbd6fee47a1bda76cc1217f899b": {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "The template deployment properties.",
            "old": "Deployment properties."
          }
        },
        {
          "@removed_e1cde62dae5b4269bc7d37b309f9d387": {
            "#name": "location",
            "Description": "the location of the deployment.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_84fb77e37c3c40488d041a0d0d6a4ee8": {
            "#name": "tags",
            "Description": "Deployment tags",
            "Required": false,
            "Type": "object"
          }
        }
      ]
    },
    "@added_966c432523e24149a8c392964a2509e2": {
      "400": {
        "Description": "Information from validate template deployment response.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "id",
            "Description": "The ID of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "type",
            "Description": "The type of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "The template deployment properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "provisioningState",
                "Description": "Denotes the state of provisioning.",
                "Enum": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Running",
                    ""
                  ],
                  [
                    "Ready",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Created",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "correlationId",
                "Description": "The correlation ID of the deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "timestamp",
                "Description": "The timestamp of the template deployment.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "duration",
                "Description": "The duration of the template deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputs",
                "Description": "Key/value pairs that represent deployment output.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "providers",
                "Description": "The list of resource providers needed for the deployment.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Resource provider information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The provider ID.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "namespace",
                      "Description": "The namespace of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationState",
                      "Description": "The registration state of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationPolicy",
                      "Description": "The registration policy of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceTypes",
                      "Description": "The collection of provider resource types.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Resource type managed by the resource provider.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceType",
                            "Description": "The resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "locations",
                            "Description": "The collection of locations where this resource type can be created.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "locationMappings",
                            "Description": "The location mappings that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The provider extended location. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The azure location.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The extended location type.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "extendedLocations",
                                  "Description": "The extended locations for the azure location.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "aliases",
                            "Description": "The aliases that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The alias type. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": "The alias name.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "paths",
                                  "Description": "The paths for an alias.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Description": "The type of the paths for alias.",
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "path",
                                        "Description": "The path of an alias.",
                                        "Required": false,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "apiVersions",
                                        "Description": "The API versions.",
                                        "Required": false,
                                        "Type": "array",
                                        "$items": {
                                          "Type": "string"
                                        }
                                      },
                                      {
                                        "#name": "pattern",
                                        "Description": "The pattern for an alias path.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "phrase",
                                            "Description": "The alias pattern phrase.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "variable",
                                            "Description": "The alias pattern variable.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "type",
                                            "Description": "The type of alias pattern",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "NotSpecified is not allowed."
                                              ],
                                              [
                                                "Extract",
                                                "Extract is the only allowed value."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      },
                                      {
                                        "#name": "metadata",
                                        "Description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": "The type of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "The token type is not specified."
                                              ],
                                              [
                                                "Any",
                                                "The token type can be anything."
                                              ],
                                              [
                                                "String",
                                                "The token type is string."
                                              ],
                                              [
                                                "Object",
                                                "The token type is object."
                                              ],
                                              [
                                                "Array",
                                                "The token type is array."
                                              ],
                                              [
                                                "Integer",
                                                "The token type is integer."
                                              ],
                                              [
                                                "Number",
                                                "The token type is number."
                                              ],
                                              [
                                                "Boolean",
                                                "The token type is boolean."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "attributes",
                                            "Description": "The attributes of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "None",
                                                "The token that the alias path is referring to has no attributes."
                                              ],
                                              [
                                                "Modifiable",
                                                "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                },
                                {
                                  "#name": "type",
                                  "Description": "The type of the alias.",
                                  "Enum": [
                                    [
                                      "NotSpecified",
                                      "Alias type is unknown (same as not providing alias type)."
                                    ],
                                    [
                                      "PlainText",
                                      "Alias value is not secret."
                                    ],
                                    [
                                      "Mask",
                                      "Alias value is secret."
                                    ]
                                  ],
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPath",
                                  "Description": "The default path for an alias.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPattern",
                                  "Description": "The default pattern for an alias.",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "phrase",
                                      "Description": "The alias pattern phrase.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "variable",
                                      "Description": "The alias pattern variable.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "type",
                                      "Description": "The type of alias pattern",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "NotSpecified is not allowed."
                                        ],
                                        [
                                          "Extract",
                                          "Extract is the only allowed value."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                },
                                {
                                  "#name": "defaultMetadata",
                                  "Description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": "The type of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "The token type is not specified."
                                        ],
                                        [
                                          "Any",
                                          "The token type can be anything."
                                        ],
                                        [
                                          "String",
                                          "The token type is string."
                                        ],
                                        [
                                          "Object",
                                          "The token type is object."
                                        ],
                                        [
                                          "Array",
                                          "The token type is array."
                                        ],
                                        [
                                          "Integer",
                                          "The token type is integer."
                                        ],
                                        [
                                          "Number",
                                          "The token type is number."
                                        ],
                                        [
                                          "Boolean",
                                          "The token type is boolean."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "attributes",
                                      "Description": "The attributes of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "None",
                                          "The token that the alias path is referring to has no attributes."
                                        ],
                                        [
                                          "Modifiable",
                                          "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiVersions",
                            "Description": "The API version.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultApiVersion",
                            "Description": "The default API version.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "zoneMappings",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The location of the zone mapping.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "zones",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiProfiles",
                            "Description": "The API profiles for the resource provider.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "profileVersion",
                                  "Description": "The profile version.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "apiVersion",
                                  "Description": "The API version.",
                                  "Required": false,
                                  "Type": "string"
                                }
                              ]
                            }
                          },
                          {
                            "#name": "capabilities",
                            "Description": "The additional capabilities offered by this resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "properties",
                            "Description": "The properties.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "providerAuthorizationConsentState",
                      "Description": "The provider authorization consent state.",
                      "Enum": [
                        [
                          "NotSpecified",
                          ""
                        ],
                        [
                          "Required",
                          ""
                        ],
                        [
                          "NotRequired",
                          ""
                        ],
                        [
                          "Consented",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "dependencies",
                "Description": "The list of deployment dependencies.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Deployment dependency information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "dependsOn",
                      "Description": "The list of dependencies.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Deployment dependency information.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "id",
                            "Description": "The ID of the dependency.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceType",
                            "Description": "The dependency resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceName",
                            "Description": "The dependency resource name.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "id",
                      "Description": "The ID of the dependency.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceType",
                      "Description": "The dependency resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceName",
                      "Description": "The dependency resource name.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "templateLink",
                "Description": "The URI referencing the template.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the template to deploy. Use either the uri or id property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "id",
                    "Description": "The resource id of a Template Spec. Use either the id or uri property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "relativePath",
                    "Description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "queryString",
                    "Description": "The query string (for example, a SAS token) to be used with the templateLink URI.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "parameters",
                "Description": "Deployment parameters. ",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "parametersLink",
                "Description": "The URI referencing the parameters. ",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the parameters file.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "mode",
                "Description": "The deployment mode. Possible values are Incremental and Complete.",
                "Enum": [
                  [
                    "Incremental",
                    ""
                  ],
                  [
                    "Complete",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "debugSetting",
                "Description": "The debug setting of the deployment.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "detailLevel",
                    "Description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "onErrorDeployment",
                "Description": "The deployment on error behavior.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": "The state of the provisioning for the on error deployment.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
                    "Enum": [
                      [
                        "LastSuccessful",
                        ""
                      ],
                      [
                        "SpecificDeployment",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "The deployment to be used on error case.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "templateHash",
                "Description": "The hash produced for the template.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputResources",
                "Description": "Array of provisioned resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of provisioned resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "validatedResources",
                "Description": "Array of validated resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of validated resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "error",
                "Description": "The deployment error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "The error code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "The error message.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The error target.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "The error details.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "code",
                          "Description": "The error code.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "message",
                          "Description": "The error message.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "target",
                          "Description": "The error target.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "details",
                          "Description": "The error details.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        },
                        {
                          "#name": "additionalInfo",
                          "Description": "The error additional info.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The resource management error additional info.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": "The additional info type.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "info",
                                "Description": "The additional info.",
                                "Required": false,
                                "Type": "object"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "The error additional info.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The resource management error additional info.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The additional info type.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional info.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "diagnostics",
                "Description": "Contains diagnostic information collected during validation process.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "level",
                      "Description": "Denotes the additional response level.",
                      "Enum": [
                        [
                          "Warning",
                          ""
                        ],
                        [
                          "Info",
                          ""
                        ],
                        [
                          "Error",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "validationLevel",
                "Description": "The validation level of the deployment",
                "Enum": [
                  [
                    "Template",
                    "Static analysis of the template is performed."
                  ],
                  [
                    "Provider",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource."
                  ],
                  [
                    "ProviderNoRbac",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtSubscriptionScope (updated)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_ValidateAtSubscriptionScope",
  "$responses": {
    "200": {
      "Description": {
        "new": "Information from validate template deployment response.",
        "old": "Deployment information."
      },
      "$properties": [
        {
          "@added_72c01290c9a149538715d8990f2929bc": {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "The template deployment properties.",
            "old": "Deployment properties."
          }
        },
        {
          "@removed_775598880cfa459bae0974c746b6e365": {
            "#name": "location",
            "Description": "the location of the deployment.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_24ec530a435645b6a1d476917d680f17": {
            "#name": "tags",
            "Description": "Deployment tags",
            "Required": false,
            "Type": "object"
          }
        }
      ]
    },
    "@added_96b2f0486aa14230a9e6e3127f62e73e": {
      "400": {
        "Description": "Information from validate template deployment response.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "id",
            "Description": "The ID of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "type",
            "Description": "The type of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "The template deployment properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "provisioningState",
                "Description": "Denotes the state of provisioning.",
                "Enum": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Running",
                    ""
                  ],
                  [
                    "Ready",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Created",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "correlationId",
                "Description": "The correlation ID of the deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "timestamp",
                "Description": "The timestamp of the template deployment.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "duration",
                "Description": "The duration of the template deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputs",
                "Description": "Key/value pairs that represent deployment output.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "providers",
                "Description": "The list of resource providers needed for the deployment.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Resource provider information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The provider ID.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "namespace",
                      "Description": "The namespace of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationState",
                      "Description": "The registration state of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationPolicy",
                      "Description": "The registration policy of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceTypes",
                      "Description": "The collection of provider resource types.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Resource type managed by the resource provider.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceType",
                            "Description": "The resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "locations",
                            "Description": "The collection of locations where this resource type can be created.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "locationMappings",
                            "Description": "The location mappings that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The provider extended location. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The azure location.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The extended location type.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "extendedLocations",
                                  "Description": "The extended locations for the azure location.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "aliases",
                            "Description": "The aliases that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The alias type. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": "The alias name.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "paths",
                                  "Description": "The paths for an alias.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Description": "The type of the paths for alias.",
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "path",
                                        "Description": "The path of an alias.",
                                        "Required": false,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "apiVersions",
                                        "Description": "The API versions.",
                                        "Required": false,
                                        "Type": "array",
                                        "$items": {
                                          "Type": "string"
                                        }
                                      },
                                      {
                                        "#name": "pattern",
                                        "Description": "The pattern for an alias path.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "phrase",
                                            "Description": "The alias pattern phrase.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "variable",
                                            "Description": "The alias pattern variable.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "type",
                                            "Description": "The type of alias pattern",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "NotSpecified is not allowed."
                                              ],
                                              [
                                                "Extract",
                                                "Extract is the only allowed value."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      },
                                      {
                                        "#name": "metadata",
                                        "Description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": "The type of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "The token type is not specified."
                                              ],
                                              [
                                                "Any",
                                                "The token type can be anything."
                                              ],
                                              [
                                                "String",
                                                "The token type is string."
                                              ],
                                              [
                                                "Object",
                                                "The token type is object."
                                              ],
                                              [
                                                "Array",
                                                "The token type is array."
                                              ],
                                              [
                                                "Integer",
                                                "The token type is integer."
                                              ],
                                              [
                                                "Number",
                                                "The token type is number."
                                              ],
                                              [
                                                "Boolean",
                                                "The token type is boolean."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "attributes",
                                            "Description": "The attributes of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "None",
                                                "The token that the alias path is referring to has no attributes."
                                              ],
                                              [
                                                "Modifiable",
                                                "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                },
                                {
                                  "#name": "type",
                                  "Description": "The type of the alias.",
                                  "Enum": [
                                    [
                                      "NotSpecified",
                                      "Alias type is unknown (same as not providing alias type)."
                                    ],
                                    [
                                      "PlainText",
                                      "Alias value is not secret."
                                    ],
                                    [
                                      "Mask",
                                      "Alias value is secret."
                                    ]
                                  ],
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPath",
                                  "Description": "The default path for an alias.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPattern",
                                  "Description": "The default pattern for an alias.",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "phrase",
                                      "Description": "The alias pattern phrase.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "variable",
                                      "Description": "The alias pattern variable.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "type",
                                      "Description": "The type of alias pattern",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "NotSpecified is not allowed."
                                        ],
                                        [
                                          "Extract",
                                          "Extract is the only allowed value."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                },
                                {
                                  "#name": "defaultMetadata",
                                  "Description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": "The type of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "The token type is not specified."
                                        ],
                                        [
                                          "Any",
                                          "The token type can be anything."
                                        ],
                                        [
                                          "String",
                                          "The token type is string."
                                        ],
                                        [
                                          "Object",
                                          "The token type is object."
                                        ],
                                        [
                                          "Array",
                                          "The token type is array."
                                        ],
                                        [
                                          "Integer",
                                          "The token type is integer."
                                        ],
                                        [
                                          "Number",
                                          "The token type is number."
                                        ],
                                        [
                                          "Boolean",
                                          "The token type is boolean."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "attributes",
                                      "Description": "The attributes of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "None",
                                          "The token that the alias path is referring to has no attributes."
                                        ],
                                        [
                                          "Modifiable",
                                          "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiVersions",
                            "Description": "The API version.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultApiVersion",
                            "Description": "The default API version.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "zoneMappings",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The location of the zone mapping.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "zones",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiProfiles",
                            "Description": "The API profiles for the resource provider.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "profileVersion",
                                  "Description": "The profile version.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "apiVersion",
                                  "Description": "The API version.",
                                  "Required": false,
                                  "Type": "string"
                                }
                              ]
                            }
                          },
                          {
                            "#name": "capabilities",
                            "Description": "The additional capabilities offered by this resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "properties",
                            "Description": "The properties.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "providerAuthorizationConsentState",
                      "Description": "The provider authorization consent state.",
                      "Enum": [
                        [
                          "NotSpecified",
                          ""
                        ],
                        [
                          "Required",
                          ""
                        ],
                        [
                          "NotRequired",
                          ""
                        ],
                        [
                          "Consented",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "dependencies",
                "Description": "The list of deployment dependencies.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Deployment dependency information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "dependsOn",
                      "Description": "The list of dependencies.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Deployment dependency information.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "id",
                            "Description": "The ID of the dependency.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceType",
                            "Description": "The dependency resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceName",
                            "Description": "The dependency resource name.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "id",
                      "Description": "The ID of the dependency.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceType",
                      "Description": "The dependency resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceName",
                      "Description": "The dependency resource name.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "templateLink",
                "Description": "The URI referencing the template.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the template to deploy. Use either the uri or id property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "id",
                    "Description": "The resource id of a Template Spec. Use either the id or uri property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "relativePath",
                    "Description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "queryString",
                    "Description": "The query string (for example, a SAS token) to be used with the templateLink URI.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "parameters",
                "Description": "Deployment parameters. ",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "parametersLink",
                "Description": "The URI referencing the parameters. ",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the parameters file.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "mode",
                "Description": "The deployment mode. Possible values are Incremental and Complete.",
                "Enum": [
                  [
                    "Incremental",
                    ""
                  ],
                  [
                    "Complete",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "debugSetting",
                "Description": "The debug setting of the deployment.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "detailLevel",
                    "Description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "onErrorDeployment",
                "Description": "The deployment on error behavior.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": "The state of the provisioning for the on error deployment.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
                    "Enum": [
                      [
                        "LastSuccessful",
                        ""
                      ],
                      [
                        "SpecificDeployment",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "The deployment to be used on error case.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "templateHash",
                "Description": "The hash produced for the template.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputResources",
                "Description": "Array of provisioned resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of provisioned resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "validatedResources",
                "Description": "Array of validated resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of validated resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "error",
                "Description": "The deployment error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "The error code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "The error message.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The error target.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "The error details.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "code",
                          "Description": "The error code.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "message",
                          "Description": "The error message.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "target",
                          "Description": "The error target.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "details",
                          "Description": "The error details.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        },
                        {
                          "#name": "additionalInfo",
                          "Description": "The error additional info.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The resource management error additional info.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": "The additional info type.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "info",
                                "Description": "The additional info.",
                                "Required": false,
                                "Type": "object"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "The error additional info.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The resource management error additional info.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The additional info type.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional info.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "diagnostics",
                "Description": "Contains diagnostic information collected during validation process.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "level",
                      "Description": "Denotes the additional response level.",
                      "Enum": [
                        [
                          "Warning",
                          ""
                        ],
                        [
                          "Info",
                          ""
                        ],
                        [
                          "Error",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "validationLevel",
                "Description": "The validation level of the deployment",
                "Enum": [
                  [
                    "Template",
                    "Static analysis of the template is performed."
                  ],
                  [
                    "Provider",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource."
                  ],
                  [
                    "ProviderNoRbac",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Validate (updated)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_Validate",
  "$responses": {
    "200": {
      "Description": {
        "new": "Information from validate template deployment response.",
        "old": "Deployment information."
      },
      "$properties": [
        {
          "@added_88ac2a1520164473ae3a703ad823285e": {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "The template deployment properties.",
            "old": "Deployment properties."
          }
        },
        {
          "@removed_de4ad64e7e2442269a2f1a2b6710ef53": {
            "#name": "location",
            "Description": "the location of the deployment.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_1872f89349134f8e8ed9040975ec9997": {
            "#name": "tags",
            "Description": "Deployment tags",
            "Required": false,
            "Type": "object"
          }
        }
      ]
    },
    "@added_39484fab52ce4514a81ce4815007d25f": {
      "400": {
        "Description": "Information from validate template deployment response.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The deployment validation error.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "details",
                      "Description": "The error details.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "id",
            "Description": "The ID of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The name of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "type",
            "Description": "The type of the deployment.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "The template deployment properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "provisioningState",
                "Description": "Denotes the state of provisioning.",
                "Enum": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "Accepted",
                    ""
                  ],
                  [
                    "Running",
                    ""
                  ],
                  [
                    "Ready",
                    ""
                  ],
                  [
                    "Creating",
                    ""
                  ],
                  [
                    "Created",
                    ""
                  ],
                  [
                    "Deleting",
                    ""
                  ],
                  [
                    "Deleted",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Updating",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "correlationId",
                "Description": "The correlation ID of the deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "timestamp",
                "Description": "The timestamp of the template deployment.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "duration",
                "Description": "The duration of the template deployment.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputs",
                "Description": "Key/value pairs that represent deployment output.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "providers",
                "Description": "The list of resource providers needed for the deployment.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Resource provider information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The provider ID.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "namespace",
                      "Description": "The namespace of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationState",
                      "Description": "The registration state of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "registrationPolicy",
                      "Description": "The registration policy of the resource provider.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceTypes",
                      "Description": "The collection of provider resource types.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Resource type managed by the resource provider.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "resourceType",
                            "Description": "The resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "locations",
                            "Description": "The collection of locations where this resource type can be created.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "locationMappings",
                            "Description": "The location mappings that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The provider extended location. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The azure location.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The extended location type.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "extendedLocations",
                                  "Description": "The extended locations for the azure location.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "aliases",
                            "Description": "The aliases that are supported by this resource type.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Description": "The alias type. ",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": "The alias name.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "paths",
                                  "Description": "The paths for an alias.",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Description": "The type of the paths for alias.",
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "path",
                                        "Description": "The path of an alias.",
                                        "Required": false,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "apiVersions",
                                        "Description": "The API versions.",
                                        "Required": false,
                                        "Type": "array",
                                        "$items": {
                                          "Type": "string"
                                        }
                                      },
                                      {
                                        "#name": "pattern",
                                        "Description": "The pattern for an alias path.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "phrase",
                                            "Description": "The alias pattern phrase.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "variable",
                                            "Description": "The alias pattern variable.",
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "type",
                                            "Description": "The type of alias pattern",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "NotSpecified is not allowed."
                                              ],
                                              [
                                                "Extract",
                                                "Extract is the only allowed value."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      },
                                      {
                                        "#name": "metadata",
                                        "Description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.",
                                        "Required": false,
                                        "Type": "object",
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": "The type of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "NotSpecified",
                                                "The token type is not specified."
                                              ],
                                              [
                                                "Any",
                                                "The token type can be anything."
                                              ],
                                              [
                                                "String",
                                                "The token type is string."
                                              ],
                                              [
                                                "Object",
                                                "The token type is object."
                                              ],
                                              [
                                                "Array",
                                                "The token type is array."
                                              ],
                                              [
                                                "Integer",
                                                "The token type is integer."
                                              ],
                                              [
                                                "Number",
                                                "The token type is number."
                                              ],
                                              [
                                                "Boolean",
                                                "The token type is boolean."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          },
                                          {
                                            "#name": "attributes",
                                            "Description": "The attributes of the token that the alias path is referring to.",
                                            "Enum": [
                                              [
                                                "None",
                                                "The token that the alias path is referring to has no attributes."
                                              ],
                                              [
                                                "Modifiable",
                                                "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                              ]
                                            ],
                                            "Required": false,
                                            "Type": "string"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                },
                                {
                                  "#name": "type",
                                  "Description": "The type of the alias.",
                                  "Enum": [
                                    [
                                      "NotSpecified",
                                      "Alias type is unknown (same as not providing alias type)."
                                    ],
                                    [
                                      "PlainText",
                                      "Alias value is not secret."
                                    ],
                                    [
                                      "Mask",
                                      "Alias value is secret."
                                    ]
                                  ],
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPath",
                                  "Description": "The default path for an alias.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "defaultPattern",
                                  "Description": "The default pattern for an alias.",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "phrase",
                                      "Description": "The alias pattern phrase.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "variable",
                                      "Description": "The alias pattern variable.",
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "type",
                                      "Description": "The type of alias pattern",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "NotSpecified is not allowed."
                                        ],
                                        [
                                          "Extract",
                                          "Extract is the only allowed value."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                },
                                {
                                  "#name": "defaultMetadata",
                                  "Description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata",
                                  "Required": false,
                                  "Type": "object",
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": "The type of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "NotSpecified",
                                          "The token type is not specified."
                                        ],
                                        [
                                          "Any",
                                          "The token type can be anything."
                                        ],
                                        [
                                          "String",
                                          "The token type is string."
                                        ],
                                        [
                                          "Object",
                                          "The token type is object."
                                        ],
                                        [
                                          "Array",
                                          "The token type is array."
                                        ],
                                        [
                                          "Integer",
                                          "The token type is integer."
                                        ],
                                        [
                                          "Number",
                                          "The token type is number."
                                        ],
                                        [
                                          "Boolean",
                                          "The token type is boolean."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    },
                                    {
                                      "#name": "attributes",
                                      "Description": "The attributes of the token that the alias path is referring to.",
                                      "Enum": [
                                        [
                                          "None",
                                          "The token that the alias path is referring to has no attributes."
                                        ],
                                        [
                                          "Modifiable",
                                          "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
                                        ]
                                      ],
                                      "Required": false,
                                      "Type": "string"
                                    }
                                  ]
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiVersions",
                            "Description": "The API version.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultApiVersion",
                            "Description": "The default API version.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "zoneMappings",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "location",
                                  "Description": "The location of the zone mapping.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "zones",
                                  "Required": false,
                                  "Type": "array",
                                  "$items": {
                                    "Type": "string"
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "apiProfiles",
                            "Description": "The API profiles for the resource provider.",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "profileVersion",
                                  "Description": "The profile version.",
                                  "Required": false,
                                  "Type": "string"
                                },
                                {
                                  "#name": "apiVersion",
                                  "Description": "The API version.",
                                  "Required": false,
                                  "Type": "string"
                                }
                              ]
                            }
                          },
                          {
                            "#name": "capabilities",
                            "Description": "The additional capabilities offered by this resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "properties",
                            "Description": "The properties.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "providerAuthorizationConsentState",
                      "Description": "The provider authorization consent state.",
                      "Enum": [
                        [
                          "NotSpecified",
                          ""
                        ],
                        [
                          "Required",
                          ""
                        ],
                        [
                          "NotRequired",
                          ""
                        ],
                        [
                          "Consented",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "dependencies",
                "Description": "The list of deployment dependencies.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Deployment dependency information.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "dependsOn",
                      "Description": "The list of dependencies.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "Deployment dependency information.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "id",
                            "Description": "The ID of the dependency.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceType",
                            "Description": "The dependency resource type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "resourceName",
                            "Description": "The dependency resource name.",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    },
                    {
                      "#name": "id",
                      "Description": "The ID of the dependency.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceType",
                      "Description": "The dependency resource type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceName",
                      "Description": "The dependency resource name.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "templateLink",
                "Description": "The URI referencing the template.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the template to deploy. Use either the uri or id property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "id",
                    "Description": "The resource id of a Template Spec. Use either the id or uri property, but not both.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "relativePath",
                    "Description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "queryString",
                    "Description": "The query string (for example, a SAS token) to be used with the templateLink URI.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "parameters",
                "Description": "Deployment parameters. ",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "parametersLink",
                "Description": "The URI referencing the parameters. ",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "uri",
                    "Description": "The URI of the parameters file.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "contentVersion",
                    "Description": "If included, must match the ContentVersion in the template.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "mode",
                "Description": "The deployment mode. Possible values are Incremental and Complete.",
                "Enum": [
                  [
                    "Incremental",
                    ""
                  ],
                  [
                    "Complete",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "debugSetting",
                "Description": "The debug setting of the deployment.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "detailLevel",
                    "Description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "onErrorDeployment",
                "Description": "The deployment on error behavior.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "provisioningState",
                    "Description": "The state of the provisioning for the on error deployment.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
                    "Enum": [
                      [
                        "LastSuccessful",
                        ""
                      ],
                      [
                        "SpecificDeployment",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "The deployment to be used on error case.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "templateHash",
                "Description": "The hash produced for the template.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "outputResources",
                "Description": "Array of provisioned resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of provisioned resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "validatedResources",
                "Description": "Array of validated resources.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Details of validated resources.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "id",
                      "Description": "The fully qualified resource Id.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "error",
                "Description": "The deployment error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "The error code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "The error message.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The error target.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "The error details.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "code",
                          "Description": "The error code.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "message",
                          "Description": "The error message.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "target",
                          "Description": "The error target.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "details",
                          "Description": "The error details.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Type": "string"
                          }
                        },
                        {
                          "#name": "additionalInfo",
                          "Description": "The error additional info.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The resource management error additional info.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": "The additional info type.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "info",
                                "Description": "The additional info.",
                                "Required": false,
                                "Type": "object"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "additionalInfo",
                    "Description": "The error additional info.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "The resource management error additional info.",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The additional info type.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional info.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "diagnostics",
                "Description": "Contains diagnostic information collected during validation process.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "level",
                      "Description": "Denotes the additional response level.",
                      "Enum": [
                        [
                          "Warning",
                          ""
                        ],
                        [
                          "Info",
                          ""
                        ],
                        [
                          "Error",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "code",
                      "Description": "The error code.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "message",
                      "Description": "The error message.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "target",
                      "Description": "The error target.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "additionalInfo",
                      "Description": "The error additional info.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The resource management error additional info.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "type",
                            "Description": "The additional info type.",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "info",
                            "Description": "The additional info.",
                            "Required": false,
                            "Type": "object"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "validationLevel",
                "Description": "The validation level of the deployment",
                "Enum": [
                  [
                    "Template",
                    "Static analysis of the template is performed."
                  ],
                  [
                    "Provider",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource."
                  ],
                  [
                    "ProviderNoRbac",
                    "Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
resourceGroupName:
{
Description: The name of the resource group the template will be deployed to. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}