Test-​Azure​Rm​Resource​Group​Deployment

Validates a resource group deployment.

Syntax

Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateFile <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateFile <String>
    -TemplateParameterObject <Hashtable>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateFile <String>
    -TemplateParameterFile <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateFile <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    -TemplateParameterUri <String>
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterObject <Hashtable>
    -TemplateUri <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateUri <String>
    -TemplateParameterFile <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateUri <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    -TemplateParameterUri <String>
    [<CommonParameters>]
Test-AzureRmResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateUri <String>
    [-ApiVersion <String>]
    [-Mode <DeploymentMode>]
    [-Pre]
    [<CommonParameters>]

Description

The Test-AzureRmResourceGroupDeployment cmdlet determines whether an Azure resource group deployment template and its parameter values are valid.

Examples

1:

Required Parameters

-ResourceGroupName

Specifies the name of the resource group to test.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TemplateFile

Specifies the full path of a JSON template file.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TemplateParameterFile

Specifies the full path of a JSON file that contains the names and values of the template parameters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TemplateParameterObject

Specifies a hash table of template parameter names and values.

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TemplateParameterUri

Specifies the URI of a template parameters file.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TemplateUri

Specifies the URI of a JSON template file.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ApiVersion

Specifies the API version that is supported by the resource Provider. You can specify a different version than the default version.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Mode

Specifies the deployment mode. The acceptable values for this parameter are:- Incremental

  • Complete
Type:DeploymentMode
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Pre

Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False