Set-AzSubscriptionDeploymentStack
Sets a new Subscription scoped Deployment Stack.
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateFile <String>
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateFile <String>
-TemplateParameterUri <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateFile <String>
-TemplateParameterObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateUri <String>
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateUri <String>
-TemplateParameterUri <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateUri <String>
-TemplateParameterObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateSpecId <String>
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateSpecId <String>
-TemplateParameterUri <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateSpecId <String>
-TemplateParameterObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSubscriptionDeploymentStack
-Name <String>
[-Description <String>]
-Location <String>
[-DeploymentResourceGroupName <String>]
-ActionOnUnmanage <PSActionOnUnmanage>
-DenySettingsMode <PSDenySettingsMode>
[-DenySettingsExcludedPrincipal <String[]>]
[-DenySettingsExcludedAction <String[]>]
[-DenySettingsApplyToChildScopes]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-BypassStackOutOfSyncError]
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-QueryString <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update a subscription scoped deployment stack.
Set-AzSubscriptionDeploymentStack -Name MySubStack -TemplateFile myTemplate.json -Location westus -DenySettingsMode DenyDelete
Update a subscription scoped deployment stack named 'MySubStack' in the default subscription, with deny settings being DenyDelete.
Set-AzSubscriptionDeploymentStack -Name MySubStack -Location westus -DenySettingsMode DenyDelete -TemplateParameterFile "./parameters.bicepparam"
This command updates a stack at the subscription scope by using a .bicepparam file on disk.
Action to take on resources that become unmanaged on deletion or update of the deployment stack. Possible values include: 'detachAll' (do not delete any unmanaged resources), 'deleteResources' (delete all unmanaged resources that are not RGs or MGs), and 'deleteAll' (delete every unmanaged resource).
Type: | PSActionOnUnmanage |
Accepted values: | DetachAll, DeleteResources, DeleteAll |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Run cmdlet in the background.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Bypass errors for the stack being out of sync when running the operation. If the stack is out of sync and this parameter is not set, the operation will fail. Only include this parameter if instructed to do so on a failed stack operation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Apply to child scopes.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Mode for DenySettings. Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'.
Type: | PSDenySettingsMode |
Accepted values: | None, DenyDelete, DenyWriteAndDelete |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The ResourceGroup at which the deployment will be created. If none is specified, it will default to the subscription level scope of the deployment stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Description for the stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Do not ask for confirmation when overwriting an existing stack.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Location of the stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The name of the deploymentStack to create.
Type: | String |
Aliases: | StackName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The tags to put on the deployment.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
TemplateFile to be used to create the stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Parameter file to use for the template.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
A hash table which represents the parameters.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Location of the Parameter file to use for the template.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
ResourceId of the TemplateSpec to be used to create the stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Location of the Template to be used to create the stack.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Azure PowerShell feedback
Azure PowerShell is an open source project. Select a link to provide feedback: