az stack group
Manage Deployment Stacks at resource group.
Commands
Name | Description | Type | Status |
---|---|---|---|
az stack group create |
Create or update a deployment stack at resource group scope. |
Core | GA |
az stack group delete |
Delete specified deployment stack from resource group scope. |
Core | GA |
az stack group export |
Export the template used to create the deployment stack from resource group scope. |
Core | GA |
az stack group list |
List all deployment stacks in resource group. |
Core | GA |
az stack group show |
Get specified deployment stack from resource group scope. |
Core | GA |
az stack group validate |
Validate a deployment stack at resource group scope. |
Core | GA |
az stack group create
Create or update a deployment stack at resource group scope.
az stack group create --action-on-unmanage --aou {deleteAll, deleteResources, detachAll}
--deny-settings-mode --dm {denyDelete, denyWriteAndDelete, none}
--name
--resource-group
[--bse --bypass-stack-out-of-sync-error {false, true}]
[--cs --deny-settings-apply-to-child-scopes]
[--deny-settings-excluded-actions --ea]
[--deny-settings-excluded-principals --ep]
[--description]
[--no-wait]
[--parameters]
[--query-string]
[--tags]
[--template-file]
[--template-spec]
[--template-uri]
[--yes]
Examples
Create a deployment stack using template file and delete resources on unmanage.
az stack group create --name StackName --resource-group ResourceGroup --action-on-unmanage deleteResources --template-file simpleTemplate.json --description description --deny-settings-mode None
Create a deployment stack with parameter file and detach all resources on unmanage.
az stack group create --name StackName --resource-group ResourceGroup --action-on-unmanage detachAll --template-file simpleTemplate.json --parameters simpleTemplateParams.json --description description --deny-settings-mode None
Create a deployment stack with template spec and delete all resources on unmanage.
az stack group create --name StackName --resource-group ResourceGroup --action-on-unmanage deleteAll --template-spec TemplateSpecResourceIDWithVersion --description description --deny-settings-mode None
Create a deployment stack using bicep file.
az stack group create --name StackName --resource-group ResourceGroup --template-file simple.bicep --description description --deny-settings-mode None --action-on-unmanage deleteResources
Create a deployment stack at a different subscription.
az stack group create --name StackName --resource-group ResourceGroup --template-file simpleTemplate.json --description description --subscription subscriptionId --deny-settings-mode None --action-on-unmanage deleteResources
Create a deployment stack using parameters from key/value pairs.
az stack group create --name StackName --template-file simpleTemplate.json --resource-group ResourceGroup --description description --parameters simpleTemplateParams.json value1=foo value2=bar --deny-settings-mode None --action-on-unmanage deleteResources
Create a deployment stack from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
az stack group create --name StackName --template-file azuredeploy.json --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json --resource-group ResourceGroup --deny-settings-mode None --action-on-unmanage deleteResources
Create a deployment stack from a local template, using deny settings.
az stack group create --name StackName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-excluded-principals "test1 test2" --action-on-unmanage deleteResources
Create a deployment stack from a local template, apply deny setting to child scopes.
az stack group create --name StackName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-apply-to-child-scopes --action-on-unmanage deleteResources
Required Parameters
Defines what happens to resources that are no longer managed after the stack is updated or deleted.
Property | Value |
---|---|
Accepted values: | deleteAll, deleteResources, detachAll |
Define which operations are denied on resources managed by the stack.
Property | Value |
---|---|
Accepted values: | denyDelete, denyWriteAndDelete, none |
The name of the deployment stack.
The resource group where the deployment stack will be created.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
DenySettings will be applied to child scopes.
Property | Value |
---|---|
Default value: | False |
List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted.
List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted.
The description of deployment stack.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Parameters may be supplied from a file using the @{path}
syntax, a JSON string, or as <KEY=VALUE>
pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
The query string (a SAS token) to be used with the template-uri in the case of linked templates.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
A path to a template file or Bicep file in the file system.
The template spec resource id.
A uri to a remote template file.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az stack group delete
Delete specified deployment stack from resource group scope.
az stack group delete --action-on-unmanage --aou {deleteAll, deleteResources, detachAll}
[--bse --bypass-stack-out-of-sync-error {false, true}]
[--id]
[--name]
[--resource-group]
[--yes]
Examples
Delete stack by name.
az stack group delete --name StackName --resource-group ResourceGroup --action-on-unmanage deleteResources
Delete stack by stack resource id.
az stack group delete --id /subscriptions/111111111111/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/StackName --action-on-unmanage detachAll
Required Parameters
Defines what happens to resources that are no longer managed after the stack is updated or deleted.
Property | Value |
---|---|
Accepted values: | deleteAll, deleteResources, detachAll |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
The deployment stack resource id.
The deployment stack name.
The resource group where the deployment stack exists.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az stack group export
Export the template used to create the deployment stack from resource group scope.
az stack group export [--id]
[--name]
[--resource-group]
Examples
Export template by name.
az stack group export --name StackName --resource-group ResourceGroup
Export template by stack resource id.
az stack group export --id /subscriptions/111111111111/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/StackName
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The deployment stack resource id.
The deployment stack name.
The resource group where the deployment stack exists.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az stack group list
List all deployment stacks in resource group.
az stack group list --resource-group
Examples
List all stacks in resource group
az stack group list --resource-group ResourceGroup
Required Parameters
The resource group where the deployment stack exists.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az stack group show
Get specified deployment stack from resource group scope.
az stack group show [--id]
[--name]
[--resource-group]
Examples
Get stack by name.
az stack group show --name StackName --resource-group ResourceGroup
Get stack by stack resource id.
az stack group show --id /subscriptions/111111111111/resourceGroups/ResourceGroup/providers/Microsoft.Resources/deploymentStacks/StackName
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The deployment stack resource id.
The deployment stack name.
The resource group where the deployment stack exists.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az stack group validate
Validate a deployment stack at resource group scope.
az stack group validate --action-on-unmanage --aou {deleteAll, deleteResources, detachAll}
--deny-settings-mode --dm {denyDelete, denyWriteAndDelete, none}
--name
--resource-group
[--bse --bypass-stack-out-of-sync-error {false, true}]
[--cs --deny-settings-apply-to-child-scopes]
[--deny-settings-excluded-actions --ea]
[--deny-settings-excluded-principals --ep]
[--description]
[--parameters]
[--query-string]
[--tags]
[--template-file]
[--template-spec]
[--template-uri]
Examples
Validate a deployment stack using template file and delete resources on unmanage.
az stack group validate --name StackName --resource-group ResourceGroup --action-on-unmanage deleteResources --template-file simpleTemplate.json --description description --deny-settings-mode None
Validate a deployment stack with parameter file and detach all resources on unmanage.
az stack group validate --name StackName --resource-group ResourceGroup --action-on-unmanage detachAll --template-file simpleTemplate.json --parameters simpleTemplateParams.json --description description --deny-settings-mode None
Validate a deployment stack with template spec and delete all resources on unmanage.
az stack group validate --name StackName --resource-group ResourceGroup --action-on-unmanage deleteAll --template-spec TemplateSpecResourceIDWithVersion --description description --deny-settings-mode None
Validate a deployment stack using bicep file.
az stack group validate --name StackName --resource-group ResourceGroup --template-file simple.bicep --description description --deny-settings-mode None --action-on-unmanage deleteResources
Validate a deployment stack at a different subscription.
az stack group validate --name StackName --resource-group ResourceGroup --template-file simpleTemplate.json --description description --subscription subscriptionId --deny-settings-mode None --action-on-unmanage deleteResources
Validate a deployment stack using parameters from key/value pairs.
az stack group validate --name StackName --template-file simpleTemplate.json --resource-group ResourceGroup --description description --parameters simpleTemplateParams.json value1=foo value2=bar --deny-settings-mode None --action-on-unmanage deleteResources
Validate a deployment stack from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
az stack group validate --name StackName --template-file azuredeploy.json --parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json --resource-group ResourceGroup --deny-settings-mode None --action-on-unmanage deleteResources
Validate a deployment stack from a local template, using deny settings.
az stack group validate --name StackName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-excluded-principals "test1 test2" --action-on-unmanage deleteResources
Validate a deployment stack from a local template, apply deny setting to child scopes.
az stack group validate --name StackName --resource-group ResourceGroup --template-file azuredeploy.json --deny-settings-mode denyDelete --deny-settings-excluded-actions Microsoft.Compute/virtualMachines/write --deny-settings-apply-to-child-scopes --action-on-unmanage deleteResources
Required Parameters
Defines what happens to resources that are no longer managed after the stack is updated or deleted.
Property | Value |
---|---|
Accepted values: | deleteAll, deleteResources, detachAll |
Define which operations are denied on resources managed by the stack.
Property | Value |
---|---|
Accepted values: | denyDelete, denyWriteAndDelete, none |
The name of the deployment stack.
The resource group where the deployment stack will be created.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
DenySettings will be applied to child scopes.
Property | Value |
---|---|
Default value: | False |
List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted.
List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted.
The description of deployment stack.
Parameters may be supplied from a file using the @{path}
syntax, a JSON string, or as <KEY=VALUE>
pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
The query string (a SAS token) to be used with the template-uri in the case of linked templates.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
A path to a template file or Bicep file in the file system.
The template spec resource id.
A uri to a remote template file.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |