Asks Azure Resource Manager to validate a management-group deployment without creating or
modifying resources. Supply one template source: a local ARM JSON or Bicep file (-TemplateFile),
a nonempty template hash table (-TemplateObject), a remote ARM template (-TemplateUri),
or a template spec version (-TemplateSpecId). A .bicepparam file supplied with -ParametersFile
can provide its own template reference.
Supply template parameters with -ParametersFile, -ParametersUri, or a string array through
-Parameter. Inline values override matching values from a local parameters file.
-ParametersUri cannot be combined with -ParametersFile or -Parameter.
-QueryString supplies a query string for the template URI, not template parameter values.
Validation always uses Incremental mode, even when -Mode Complete is supplied.
On success, the cmdlet returns a DeploymentValidateResult. Validation failures are reported
on the error stream, not returned as validation-error objects in normal output.
Accepts Incremental (default) or Complete for compatibility with the create command.
Validation always uses Incremental, even when Complete is supplied.
The name used for validation. When omitted, defaults to the template file or URI name without its extension, or a generated GUID when no valid name can be derived.
Use 1-64 characters: letters, numbers, underscores, hyphens, periods, or parentheses.
Template parameters supplied as a string array, for example
-Parameter 'policyName=audit-tags','count=3'. Each item can be a Name=Value pair,
a JSON parameters object, or a JSON parameters file path (optionally prefixed with @).
Values are parsed as JSON when possible; otherwise they are strings.
Later values override earlier values and matching keys in -ParametersFile.
Cannot be combined with -ParametersUri. Specify -Parameter once with all values.
Path to a local ARM JSON parameters file or .bicepparam file. Inline -Parameter values
can override values from this file. A .bicepparam file can supply its own template reference.
Cannot be combined with -ParametersUri. Also accepts the alias -TemplateParameterFile.
URI of a remote ARM JSON parameters file (for example, a blob URL).
Cannot be combined with -ParametersFile or -Parameter.
Include any required SAS token in this URI; -QueryString does not modify it.
Also accepts the alias -TemplateParameterUri.
Optional SAS token or query string sent on the template link. Requires -TemplateUri.
A leading ? or & is removed. This value is not added to -ParametersUri.
Resource ID of an existing template spec version to validate (for example, /subscriptions/.../providers/Microsoft.Resources/templateSpecs/<spec>/versions/<version>).
URI of a remote ARM JSON template (for example, a blob URL).
Bicep source must be supplied locally with -TemplateFile, where it is compiled before submission.
Validation level sent to Azure Resource Manager. Standard values are Template, Provider,
and ProviderNoRbac. ProviderNoRbac uses read-permission checks instead of full deployment
permission checks; it does not skip all RBAC checks. When omitted, no level is sent and
Azure Resource Manager applies its default.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
A DeploymentValidateResult describing the outcome of the validation, including the validated resources and the deployment properties Azure Resource Manager resolved. No resources are created or modified.
Notes
Validation is read-only: it never creates or modifies resources. Use New-AzManagementGroupDeployment to deploy once validation passes.
The CLI and PowerShell validation commands share the same result/error behavior, consistent
with the AzClips resource-group validation commands. Missing required parameters in a local
or inline template cause an error rather than an interactive prompt.
This cmdlet does not support -WhatIf or -Confirm.
Bicep templates and .bicepparam files require the Bicep CLI for local compilation.
Differences from Az.Resources: on success this cmdlet returns the DeploymentValidateResult instead of no output, and validation failures are written to the error stream instead of to the output stream as a list of PSResourceManagerError objects. The legacy parameter names -TemplateParameterFile and -TemplateParameterUri are accepted as aliases. -TemplateParameterObject, dynamic template parameters, -SkipTemplateParameterPrompt, -SuppressDiagnostics, and -Pre are not supported.
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.