Test-AzTenantDeployment
Validate an ARM or Bicep template deployment at tenant scope.
Syntax
Default (Default)
Test-AzTenantDeployment
-Location <string>
[-Name <string>]
[-TemplateUri <string>]
[-TemplateFile <string>]
[-TemplateSpecId <string>]
[-QueryString <string>]
[-ParametersUri <string>]
[-ParametersFile <string>]
[-Parameter <string[]>]
[-ValidationLevel <string>]
[-Profile <string>]
[<CommonParameters>]
Aliases
This cmdlet has no aliases.
Description
Validates whether a template is syntactically correct and would be accepted by Azure Resource
Manager at tenant scope, without deploying it. Supply one template
source: a local ARM JSON or Bicep file (-TemplateFile), a remote ARM template (-TemplateUri),
or a template spec version (-TemplateSpecId). A .bicepparam file supplied with -ParametersFile
can provide its own template reference, so a separate template source is not required in that case.
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.
-Name defaults to a generated GUID when omitted. Tenant deployments always use Incremental mode.
If the template fails validation, the cmdlet raises an error that lists each validation error; otherwise it returns the validation result.
Examples
Validate a Bicep file at tenant scope
Test-AzTenantDeployment -Location eastus -TemplateFile .\main.bicep -Parameter environment=prod
Parameters
-Location
The Azure location where the deployment metadata is stored.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the deployment. Defaults to a generated GUID when omitted.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeploymentName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Parameter
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.
Parameter properties
| Type: | String[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ParametersFile
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.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ParametersUri
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.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Profile
Name of a saved profile to use for this call instead of the currently-active one. Manage profiles with Set-AzProfile / Get-AzProfile.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-QueryString
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.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TemplateFile
Path to a local ARM JSON or Bicep template file.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TemplateSpecId
Resource ID of an existing template spec version to deploy (for example, /subscriptions/.../providers/Microsoft.Resources/templateSpecs/<spec>/versions/<version>).
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TemplateUri
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.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ValidationLevel
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.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
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.
Inputs
None
This cmdlet does not accept pipeline input.
Outputs
Microsoft.Azure.Azclips.Extensions.Resources.Models.DeploymentValidateResult
The validation result, including the validated deployment properties. A template that fails validation raises an error instead.
Notes
Missing required parameters in a local or inline template cause an error rather than an
interactive prompt. Bicep templates and .bicepparam files are compiled locally before submission.
The Bicep CLI must be installed to use these file types.
Differences from Az.Resources: validation errors raise a terminating error instead of being written as PSResourceManagerError objects, and a successful validation returns DeploymentValidateResult. Template parameters are passed with -Parameter, -ParametersFile, or -ParametersUri instead of dynamic parameters, -TemplateObject, or -TemplateParameterObject. -SkipTemplateParameterPrompt, -SuppressDiagnostics, and -Pre are not supported.