Microsoft.Resources (stable:2024-11-01)

2025/02/18 • 4 updated methods

Deployments_WhatIfAtTenantScope (updated)
Description :  Returns changes that will be made by the deployment if executed at the scope of the tenant group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_WhatIfAtTenantScope",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "changes": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          },
          {
            "potentialChanges": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIfAtManagementGroupScope (updated)
Description :  Returns changes that will be made by the deployment if executed at the scope of the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_WhatIfAtManagementGroupScope",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "changes": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          },
          {
            "potentialChanges": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIfAtSubscriptionScope (updated)
Description :  Returns changes that will be made by the deployment if executed at the scope of the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_WhatIfAtSubscriptionScope",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "changes": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          },
          {
            "potentialChanges": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to What If. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIf (updated)
Description :  Returns changes that will be made by the deployment if executed at the scope of the resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Deployments_WhatIf",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "changes": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          },
          {
            "potentialChanges": {
              "$properties": [
                {
                  "#name": "resourceId",
                  "Required": {
                    "new": false,
                    "old": true
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
resourceGroupName:
{
Description: The name of the resource group the template will be deployed to. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: False ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}