Skip to content

Commit 170c6a5

Browse files
committed
added preview note
1 parent 0a70738 commit 170c6a5

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

articles/azure-resource-manager/template-deploy-what-if.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Template deployment what-if operation
2+
title: Template deployment what-if (Preview)
33
description: Determine what changes will happen to your resources before deploying an Azure Resource Manager template.
44
author: mumian
55
ms.service: azure-resource-manager
@@ -8,11 +8,11 @@ ms.date: 11/08/2019
88
ms.author: jgao
99

1010
---
11-
# Resource Manager template deployment what-if operation
11+
# Resource Manager template deployment what-if operation (Preview)
1212

1313
Before deploying a template, you might want to preview the changes that will happen. Azure Resource Manager provides the what-if operation to let you see how resources will change if you deploy the template. The what-if operation doesn't make any changes to existing resources. Instead, it predicts the changes if the specified template is deployed.
1414

15-
The what-if operation is currently in preview. To use it, you must sign up for the preview.
15+
The what-if operation is currently in preview. To use it, you must sign up for the preview. As a preview release, the results may sometimes show that a resource will change when actually no change will happen. We're working to reduce these issues, but we need your help. Please report these issues at [https://aka.ms/armwhatifissues](https://aka.ms/armwhatifissues).
1616

1717
You can use the what-if operation with the `New-AzDeploymentWhatIf` PowerShell command or the [Deployments - What If](/rest/api/resources/deployments/whatif) REST operation.
1818

@@ -30,12 +30,12 @@ The what-if operation lists six different types of changes:
3030

3131
- **Ignore**: The resource exists, but isn't defined in the template. The resource won't be deployed or modified.
3232

33-
- **Deploy**: The resource exists, and is defined in the template. The resource will be redeployed. The properties of the resource may or may not change. The operation returns this change type when it doesn't have enough information to determine if any properties will change. You only see this condition when [ResultFormat](#result-format) is set to `ResourceIdOnly`.
34-
3533
- **NoChange**: The resource exists, and is defined in the template. The resource will be redeployed, but the properties of the resource won't change. This change type is returned when [ResultFormat](#result-format) is set to `FullResourcePayloads`, which is the default value.
3634

3735
- **Modify**: The resource exists, and is defined in the template. The resource will be redeployed, and the properties of the resource will change. This change type is returned when [ResultFormat](#result-format) is set to `FullResourcePayloads`, which is the default value.
3836

37+
- **Deploy**: The resource exists, and is defined in the template. The resource will be redeployed. The properties of the resource may or may not change. The operation returns this change type when it doesn't have enough information to determine if any properties will change. You only see this condition when [ResultFormat](#result-format) is set to `ResourceIdOnly`.
38+
3939
## Deployment scope
4040

4141
You can use the what-if operation for deployments at either the subscription or resource group level. You set the deployment scope with the `-ScopeType` parameter. The accepted values are `Subscription` and `ResourceGroup`. This article demonstrates resource group deployments.
@@ -44,18 +44,18 @@ To learn about subscription level deployments, see [Create resource groups and r
4444

4545
## Result format
4646

47-
You can control the level of detail that is returned about the predicted changes. Set the `ResultFormat` parameter to `ResourceIdOnly` to get a list of resources that will change. Set the `ResultFormat` parameter to `FullResourcePayloads` to get a list of resources what will change and details about the properties that will change. The default value is `FullResourcePayloads`.
47+
You can control the level of detail that is returned about the predicted changes. Set the `ResultFormat` parameter to `FullResourcePayloads` to get a list of resources what will change and details about the properties that will change. Set the `ResultFormat` parameter to `ResourceIdOnly` to get a list of resources that will change. The default value is `FullResourcePayloads`.
4848

4949
The following screenshots show the two different output formats:
5050

51-
- Resource ID only
52-
53-
![Resource Manager template deployment what-if operation resourceidonly output](./media/template-deploy-what-if/resource-manager-deployment-whatif-output-resourceidonly.png)
54-
5551
- Full resource payloads
5652

5753
![Resource Manager template deployment what-if operation fullresourcepayloads output](./media/template-deploy-what-if/resource-manager-deployment-whatif-output-fullresourcepayload.png)
5854

55+
- Resource ID only
56+
57+
![Resource Manager template deployment what-if operation resourceidonly output](./media/template-deploy-what-if/resource-manager-deployment-whatif-output-resourceidonly.png)
58+
5959
## Run what-if operation
6060

6161
### Set up environment
@@ -111,6 +111,7 @@ It's important to remember what-if makes no actual changes. The storage account
111111

112112
## Next steps
113113

114+
- If you notice incorrect results from the preview release of what-if, please report the issues at [https://aka.ms/armwhatifissues](https://aka.ms/armwhatifissues).
114115
- To deploy templates with Azure PowerShell, see [Deploy resources with Resource Manager templates and Azure PowerShell](resource-group-template-deploy.md).
115116
- To deploy templates with REST, see [Deploy resources with Resource Manager templates and Resource Manager REST API](resource-group-template-deploy-rest.md).
116117
- To roll back to a successful deployment when you get an error, see [Rollback on error to successful deployment](rollback-on-error.md).

0 commit comments

Comments
 (0)