New-AzResourceGroupDeployment
In this article
Syntax
Syntax
ByTemplateFileWithNoParameters (Default)
ByTemplateObjectAndParameterObject
ByTemplateFileAndParameterObject
ByTemplateUriAndParameterObject
ByTemplateSpecResourceIdAndParamsObject
ByTemplateObjectAndParameterFile
ByTemplateFileAndParameterFile
ByTemplateUriAndParameterFile
ByTemplateSpecResourceIdAndParams
ByParameterFileWithNoTemplate
ByTemplateObjectAndParameterUri
ByTemplateFileAndParameterUri
ByTemplateUriAndParameterUri
ByTemplateSpecResourceIdAndParamsUri
ByTemplateObjectWithNoParameters
ByTemplateUriWithNoParameters
ByTemplateSpecResourceId
Description
Examples
Examples
Example 1: Use a custom template and parameter file to create a deployment
Example 2: Use a custom template object and parameter file to create a deployment
Example 3
Example 4: Deploy a template stored in a non public storage account using a uri and SAS token
Example 5: Use a .bicepparam file to create a deployment
Parameters
Parameters
-AsJob
-AuxTenant
-Confirm
-DefaultProfile
-DeploymentDebugLogLevel
-Force
-Mode
-Name
-Pre
-ProceedIfNoChange
-QueryString
-ResourceGroupName
-RollBackDeploymentName
-RollbackToLastDeployment
-SkipTemplateParameterPrompt
-Tag
-TemplateFile
-TemplateObject
-TemplateParameterFile
-TemplateParameterObject
-TemplateParameterUri
-TemplateSpecId
-TemplateUri
-ValidationLevel
-WhatIf
-WhatIfExcludeChangeType
-WhatIfResultFormat
CommonParameters
Inputs
Inputs
String
DeploymentMode
Hashtable
Outputs
Outputs
PSResourceGroupDeployment
Related Links
Show 3 more
Adds an Azure deployment to a resource group.
ByTemplateFileWithNoParameters (Default)
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateFile <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateObjectAndParameterObject
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterObject <Hashtable>
-TemplateObject <Hashtable>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateFileAndParameterObject
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateUriAndParameterObject
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParamsObject
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterObject <Hashtable>
-TemplateSpecId <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateObjectAndParameterFile
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterFile <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateFileAndParameterFile
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterFile <String>
-TemplateFile <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateUriAndParameterFile
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterFile <String>
-TemplateUri <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParams
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterFile <String>
-TemplateSpecId <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParameterFileWithNoTemplate
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterFile <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateObjectAndParameterUri
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterUri <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateFileAndParameterUri
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterUri <String>
-TemplateFile <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateUriAndParameterUri
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterUri <String>
-TemplateUri <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParamsUri
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateParameterUri <String>
-TemplateSpecId <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateObjectWithNoParameters
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTemplateUriWithNoParameters
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateUri <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzResourceGroupDeployment
-ResourceGroupName <String>
-TemplateSpecId <String>
[-Name <String>]
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-Force]
[-ProceedIfNoChange]
[-AsJob]
[-AuxTenant <String[]>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
The New-AzResourceGroupDeployment cmdlet adds a deployment to an existing resource group.
This includes the resources that the deployment requires.
An Azure resource is a user-managed Azure entity, such as a database server, database, website, virtual machine, or Storage account.
An Azure resource group is a collection of Azure resources that are deployed as a unit, such as the website, database server, and databases that are required for a financial website.
A resource group deployment uses a template to add resources to a resource group and publishes them so that they are available in Azure.
To add resources to a resource group without using a template, use the New-AzResource cmdlet.
To add a resource group deployment, specify the name of an existing resource group and a resource group template.
A resource group template is a JSON string that represents a resource group for a complex cloud-based service, such as a web portal.
The template includes parameter placeholders for required resources and configurable property values, such as names and sizes.
You can find many templates in the Azure template gallery or you can create your own templates.
To use a custom template to create a resource group, specify the TemplateFile parameter or TemplateUri parameter.
Each template has parameters for configurable properties.
To specify values for the template parameters, specify the TemplateParameterFile parameter or the TemplateParameterObject parameter.
Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template.
To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters.
Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file.
Example 1: Use a custom template and parameter file to create a deployment
New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -Tag @{"key1"="value1"; "key2"="value2";}
This command creates a new deployment by using a custom template and a template file on disk, with defined tags parameter.
The command uses the TemplateFile parameter to specify the template and the TemplateParameterFile parameter to specify a file that contains parameters and parameter values.
Example 2: Use a custom template object and parameter file to create a deployment
$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json")
$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable
New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json"
This command creates a new deployment by using a custom and a template file on disk that has been converted to an in-memory hashtable.
The first two commands read the text for the template file on disk and convert it to an in-memory hashtable.
The last command uses the TemplateObject parameter to specify the hashtable and the TemplateParameterFile parameter to specify a file that contains parameters and parameter values.
Adds an Azure deployment to a resource group. (autogenerated)
New-AzResourceGroupDeployment -DeploymentDebugLogLevel RequestContent -Name mynewstorageaccount -ResourceGroupName 'ContosoEngineering' -TemplateFile 'D:\Azure\Templates\EngineeringSite.json' -TemplateParameterObject <Hashtable>
Example 4: Deploy a template stored in a non public storage account using a uri and SAS token
New-AzResourceGroupDeployment -ResourceGroupName "RGName" -TemplateUri "https://example.com/example.json" -QueryString "foo"
This command creates a new deployment using the template in TemplateUri which is not public and requires a token parameter to access which would be provided using the QueryString parameter.
Running this command effectively accesses the template using the url https://example.com/example.json?foo
.
This can be used if you want to use a template in a storage account by providing the SAS token as the QueryString
Example 5: Use a .bicepparam file to create a deployment
New-AzResourceGroupDeployment -ResourceGroupName "RGName" -TemplateParameterFile "./parameters.bicepparam"
This command creates a new deployment at the resource group scope by using a .bicepparam file on disk.
The command uses the TemplateParameterFile parameter to specify a .bicepparam file.
Run cmdlet in the background
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Aux tenant ids for cross tenant deployments
Expand table
Type: String [ ]
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Prompts you for confirmation before running the cmdlet.
Expand table
Type: SwitchParameter
Default value: False
Supports wildcards: False
DontShow: False
Aliases: cf
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
The credentials, account, tenant, and subscription used for communication with azure
Expand table
Type: IAzureContextContainer
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies a debug log level.
The acceptable values for this parameter are:
RequestContent
ResponseContent
All
None
Expand table
Type: String
Default value: None
Accepted values: RequestContent, ResponseContent, All, None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Forces the command to run without asking for user confirmation.
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies the deployment mode. The acceptable values for this parameter are:
Complete: In complete mode, Resource Manager deletes resources that exist in the resource group but are not
specified in the template.
Incremental: In incremental mode, Resource Manager leaves unchanged resources that
exist in the resource group but are not specified in the template.
Expand table
Type: DeploymentMode
Default value: Incremental
Accepted values: Incremental, Complete
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: DeploymentName
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Do not ask for confirmation if there is no changes in the What-If result. Applicable when the -Confirm switch is set.
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies the name of the resource group to deploy.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-RollbackToLastDeployment
Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used.
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SkipTemplateParameterPrompt
Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied.
Expand table
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
The tags to put on the deployment.
Expand table
Type: Hashtable
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies the full path of a custom template file. Supported template file type: json and bicep.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateFileWithNoParameters
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
A hash table which represents the template.
Expand table
Type: Hashtable
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateObjectAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateObjectAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateObjectAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateObjectWithNoParameters
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Specifies the full path of a JSON file that contains the names and values of the template parameters.
If a template has parameters, you must specify the parameter values with the TemplateParameterFile parameter or the TemplateParameterObject parameter.
Template parameters are dynamically added to the command when you specify a template.
To use the dynamic parameters, type a minus sign (-) to indicate a parameter name and then use the Tab key to cycle through the available parameters.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateObjectAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceIdAndParams
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByParameterFileWithNoTemplate
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Specifies a hash table of template parameter names and values.
For help with hash tables in Windows PowerShell, type Get-Help about_Hash_Tables
.
If a template has parameters, you must specify parameter values.
Template parameters are dynamically added to the command when you specify a template.
Expand table
Type: Hashtable
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateObjectAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceIdAndParamsObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Specifies the URI of a template parameters file. When using TemplateParameterUri any dynamic parameters that you use are disregarded. To use dynamic parameters you must instead use the TemplateParameterFile parameter
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateObjectAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateFileAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceIdAndParamsUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Resource ID of the templateSpec to be deployed.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateSpecResourceIdAndParamsObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceIdAndParams
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceIdAndParamsUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateSpecResourceId
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Specifies the URI of a custom template file.
Expand table
Type: String
Default value: None
Supports wildcards: False
DontShow: False
ByTemplateUriAndParameterObject
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriAndParameterFile
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriAndParameterUri
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
ByTemplateUriWithNoParameters
Expand table
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
Sets the validation level for validate/what-if. ValidationLevel can be Template(Skips provider validation), Provider(Performs full validation), or ProviderNoRbac(Performs full validation using RBAC read checks instead of RBAC write checks for provider validation).
Expand table
Type: String
Default value: None(Provider)
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Expand table
Type: SwitchParameter
Default value: False
Supports wildcards: False
DontShow: False
Aliases: wi
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Comma-separated resource change types to be excluded from What-If results. Applicable when the -WhatIf or -Confirm switch is set.
Expand table
Type: String [ ]
Default value: None
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
The What-If result format.
Expand table
Type: WhatIfResultFormat
Default value: None
Accepted values: ResourceIdOnly, FullResourcePayloads
Supports wildcards: False
DontShow: False
(All)
Expand table
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
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 .