deployment_stacks_what_if_results_at_management_group

Creates, updates, deletes, gets or lists a deployment_stacks_what_if_results_at_management_group resource.

Overview

Name	deployment_stacks_what_if_results_at_management_group
Type	Resource
Id	azure.resource.deployment_stacks_what_if_results_at_management_group

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
actionOnUnmanage	object	Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. Required.
changes	object	All of the changes predicted by the deployment stack what-if operation.
correlationId	string	The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
debugSetting	object	The debug setting of the deployment.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentScope	string	The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
deploymentStackLastModified	string (date-time)	The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current.
deploymentStackResourceId	string	The deployment stack id to use as the basis for comparison. Required.
description	string	Deployment stack description. Max length of 4096 characters.
diagnostics	array	List of resource diagnostics detected by What-If operation.
error	object	The error detail.
extensionConfigs	object	The deployment extension configs. Keys of this object are extension aliases as defined in the deployment template.
externalInputDefinitions	object	External input definitions, used by external tooling to define expected external input values.
externalInputs	object	External input values, used by external tooling for parameter evaluation.
location	string	The geo-location where the resource lives. Required for subscription and management group scoped stacks. The location is inherited from the resource group for resource group scoped stacks.
parameters	object	Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.
parametersLink	object	The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
provisioningState	string	State of the deployment stack. Known values are: "creating", "validating", "waiting", "deploying", "canceling", "updatingDenyAssignments", "deletingResources", "succeeded", "failed", "canceled", "deleting", "initializing", and "running". (creating, validating, waiting, deploying, canceling, updatingDenyAssignments, deletingResources, succeeded, failed, canceled, deleting, initializing, running)
retentionInterval	string	The interval to persist the deployment stack what-if result in ISO 8601 format. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
templateLink	object	The URI of the template. Use either the templateLink property or the template property, but not both.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationLevel	string	The validation level of the deployment stack. Known values are: "Template", "Provider", and "ProviderNoRbac". (Template, Provider, ProviderNoRbac)

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
actionOnUnmanage	object	Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. Required.
changes	object	All of the changes predicted by the deployment stack what-if operation.
correlationId	string	The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
debugSetting	object	The debug setting of the deployment.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentScope	string	The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
deploymentStackLastModified	string (date-time)	The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current.
deploymentStackResourceId	string	The deployment stack id to use as the basis for comparison. Required.
description	string	Deployment stack description. Max length of 4096 characters.
diagnostics	array	List of resource diagnostics detected by What-If operation.
error	object	The error detail.
extensionConfigs	object	The deployment extension configs. Keys of this object are extension aliases as defined in the deployment template.
externalInputDefinitions	object	External input definitions, used by external tooling to define expected external input values.
externalInputs	object	External input values, used by external tooling for parameter evaluation.
location	string	The geo-location where the resource lives. Required for subscription and management group scoped stacks. The location is inherited from the resource group for resource group scoped stacks.
parameters	object	Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.
parametersLink	object	The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
provisioningState	string	State of the deployment stack. Known values are: "creating", "validating", "waiting", "deploying", "canceling", "updatingDenyAssignments", "deletingResources", "succeeded", "failed", "canceled", "deleting", "initializing", and "running". (creating, validating, waiting, deploying, canceling, updatingDenyAssignments, deletingResources, succeeded, failed, canceled, deleting, initializing, running)
retentionInterval	string	The interval to persist the deployment stack what-if result in ISO 8601 format. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
templateLink	object	The URI of the template. Use either the templateLink property or the template property, but not both.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationLevel	string	The validation level of the deployment stack. Known values are: "Template", "Provider", and "ProviderNoRbac". (Template, Provider, ProviderNoRbac)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	management_group_id, deployment_stacks_what_if_result_name		Gets the Deployment stack with the given name.
list	select	management_group_id		Lists Deployment stacks at the specified scope.
create_or_update	insert	management_group_id, deployment_stacks_what_if_result_name		Creates or updates a Deployment stack at the specified scope.
create_or_update	replace	management_group_id, deployment_stacks_what_if_result_name		Creates or updates a Deployment stack at the specified scope.
delete	delete	management_group_id, deployment_stacks_what_if_result_name	unmanageAction.Resources, unmanageAction.ResourceGroups, unmanageAction.ManagementGroups, unmanageAction.ResourcesWithoutDeleteSupport, bypassStackOutOfSyncError	Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
what_if	exec	management_group_id, deployment_stacks_what_if_result_name		Returns property-level changes that will be made by the deployment if executed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_stacks_what_if_result_name	string	Name of the deployment stack what-if result. Required.
management_group_id	string	The management group ID. Required.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.
unmanageAction.ManagementGroups	string	Flag to indicate delete rather than detach for unmanaged management groups. Known values are: "delete" and "detach". Default value is None.
unmanageAction.ResourceGroups	string	Flag to indicate delete rather than detach for unmanaged resource groups. Known values are: "delete" and "detach". Default value is None.
unmanageAction.Resources	string	Flag to indicate delete rather than detach for unmanaged resources. Known values are: "delete" and "detach". Default value is None.
unmanageAction.ResourcesWithoutDeleteSupport	string	Some resources do not support deletion. This flag will denote how the stack should handle those resources. Known values are: "detach" and "fail". Default value is None.

SELECT examples

get

Gets the Deployment stack with the given name.

SELECT
id,
name,
actionOnUnmanage,
changes,
correlationId,
debugSetting,
denySettings,
deploymentScope,
deploymentStackLastModified,
deploymentStackResourceId,
description,
diagnostics,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
location,
parameters,
parametersLink,
provisioningState,
retentionInterval,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks_what_if_results_at_management_group
WHERE management_group_id = '{{ management_group_id }}' -- required
AND deployment_stacks_what_if_result_name = '{{ deployment_stacks_what_if_result_name }}' -- required
;

list

Lists Deployment stacks at the specified scope.

SELECT
id,
name,
actionOnUnmanage,
changes,
correlationId,
debugSetting,
denySettings,
deploymentScope,
deploymentStackLastModified,
deploymentStackResourceId,
description,
diagnostics,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
location,
parameters,
parametersLink,
provisioningState,
retentionInterval,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks_what_if_results_at_management_group
WHERE management_group_id = '{{ management_group_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Deployment stack at the specified scope.

INSERT INTO azure.resource.deployment_stacks_what_if_results_at_management_group (
properties,
location,
tags,
management_group_id,
deployment_stacks_what_if_result_name
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ management_group_id }}',
'{{ deployment_stacks_what_if_result_name }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployment_stacks_what_if_results_at_management_group
props:
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the deployment_stacks_what_if_results_at_management_group resource.
  - name: deployment_stacks_what_if_result_name
    value: "{{ deployment_stacks_what_if_result_name }}"
    description: Required parameter for the deployment_stacks_what_if_results_at_management_group resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      error:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"
      template: "{{ template }}"
      templateLink:
        uri: "{{ uri }}"
        id: "{{ id }}"
        relativePath: "{{ relativePath }}"
        queryString: "{{ queryString }}"
        contentVersion: "{{ contentVersion }}"
      parameters: "{{ parameters }}"
      parametersLink:
        uri: "{{ uri }}"
        contentVersion: "{{ contentVersion }}"
      extensionConfigs: "{{ extensionConfigs }}"
      externalInputs: "{{ externalInputs }}"
      externalInputDefinitions: "{{ externalInputDefinitions }}"
      actionOnUnmanage:
        resources: "{{ resources }}"
        resourceGroups: "{{ resourceGroups }}"
        managementGroups: "{{ managementGroups }}"
        resourcesWithoutDeleteSupport: "{{ resourcesWithoutDeleteSupport }}"
      debugSetting:
        detailLevel: "{{ detailLevel }}"
      deploymentScope: "{{ deploymentScope }}"
      description: "{{ description }}"
      denySettings:
        mode: "{{ mode }}"
        excludedPrincipals:
          - "{{ excludedPrincipals }}"
        excludedActions:
          - "{{ excludedActions }}"
        applyToChildScopes: {{ applyToChildScopes }}
      provisioningState: "{{ provisioningState }}"
      correlationId: "{{ correlationId }}"
      validationLevel: "{{ validationLevel }}"
      deploymentStackResourceId: "{{ deploymentStackResourceId }}"
      deploymentStackLastModified: "{{ deploymentStackLastModified }}"
      retentionInterval: "{{ retentionInterval }}"
      changes:
        resourceChanges:
          - id: "{{ id }}"
            extension:
              name: "{{ name }}"
              version: "{{ version }}"
              configId: "{{ configId }}"
              config: "{{ config }}"
            type: "{{ type }}"
            identifiers: "{{ identifiers }}"
            apiVersion: "{{ apiVersion }}"
            deploymentId: "{{ deploymentId }}"
            symbolicName: "{{ symbolicName }}"
            changeType: "{{ changeType }}"
            changeCertainty: "{{ changeCertainty }}"
            managementStatusChange:
              before: "{{ before }}"
              after: "{{ after }}"
            denyStatusChange:
              before: "{{ before }}"
              after: "{{ after }}"
            unsupportedReason: "{{ unsupportedReason }}"
            resourceConfigurationChanges:
              before: "{{ before }}"
              after: "{{ after }}"
              delta:
                - before: "{{ before }}"
                  after: "{{ after }}"
                  path: "{{ path }}"
                  changeType: "{{ changeType }}"
                  children: "{{ children }}"
        denySettingsChange:
          before:
            mode: "{{ mode }}"
            excludedPrincipals:
              - "{{ excludedPrincipals }}"
            excludedActions:
              - "{{ excludedActions }}"
            applyToChildScopes: {{ applyToChildScopes }}
          after:
            mode: "{{ mode }}"
            excludedPrincipals:
              - "{{ excludedPrincipals }}"
            excludedActions:
              - "{{ excludedActions }}"
            applyToChildScopes: {{ applyToChildScopes }}
          delta:
            - before: "{{ before }}"
              after: "{{ after }}"
              path: "{{ path }}"
              changeType: "{{ changeType }}"
              children: "{{ children }}"
        deploymentScopeChange:
          before: "{{ before }}"
          after: "{{ after }}"
      diagnostics:
        - level: "{{ level }}"
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          additionalInfo: "{{ additionalInfo }}"
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required for subscription and management group scoped stacks. The location is inherited from the resource group for resource group scoped stacks.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Creates or updates a Deployment stack at the specified scope.

REPLACE azure.resource.deployment_stacks_what_if_results_at_management_group
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND deployment_stacks_what_if_result_name = '{{ deployment_stacks_what_if_result_name }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.

DELETE FROM azure.resource.deployment_stacks_what_if_results_at_management_group
WHERE management_group_id = '{{ management_group_id }}' --required
AND deployment_stacks_what_if_result_name = '{{ deployment_stacks_what_if_result_name }}' --required
AND unmanageAction.Resources = '{{ unmanageAction.Resources }}'
AND unmanageAction.ResourceGroups = '{{ unmanageAction.ResourceGroups }}'
AND unmanageAction.ManagementGroups = '{{ unmanageAction.ManagementGroups }}'
AND unmanageAction.ResourcesWithoutDeleteSupport = '{{ unmanageAction.ResourcesWithoutDeleteSupport }}'
AND bypassStackOutOfSyncError = '{{ bypassStackOutOfSyncError }}'
;

Lifecycle Methods

what_if

Returns property-level changes that will be made by the deployment if executed.

EXEC azure.resource.deployment_stacks_what_if_results_at_management_group.what_if 
@management_group_id='{{ management_group_id }}' --required, 
@deployment_stacks_what_if_result_name='{{ deployment_stacks_what_if_result_name }}' --required
;