deployment_stacks

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

Overview

Name	deployment_stacks
Type	Resource
Id	azure.resource.deployment_stacks

Fields

The following fields are returned by SELECT queries:

get_at_resource_group

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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_at_resource_group

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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)

get_at_subscription

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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)

get_at_management_group

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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_at_subscription

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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_at_management_group

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.
bypassStackOutOfSyncError	boolean	Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
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.
deletedResources	array	An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.
denySettings	object	Defines how resources deployed by the stack are locked. Required.
deploymentExtensions	array	The extensions used during deployment. Contains extension data for all extensible resources managed by the stack.
deploymentId	string	The resourceId of the deployment resource created by the deployment stack.
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}').
description	string	Deployment stack description. Max length of 4096 characters.
detachedResources	array	An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.
duration	string	The duration of the last successful Deployment stack update.
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.
failedResources	array	An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
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.
outputs	object	The outputs of the deployment resource created by the deployment stack.
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)
resources	array	An array of resources currently managed by the deployment stack.
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_at_resource_group	select	resource_group_name, deployment_stack_name, subscription_id		Gets the Deployment stack with the given name.
list_at_resource_group	select	resource_group_name, subscription_id		Lists Deployment stacks at the specified scope.
get_at_subscription	select	deployment_stack_name, subscription_id		Gets the Deployment stack with the given name.
get_at_management_group	select	management_group_id, deployment_stack_name		Gets the Deployment stack with the given name.
list_at_subscription	select	subscription_id		Lists Deployment stacks at the specified scope.
list_at_management_group	select	management_group_id		Lists Deployment stacks at the specified scope.
create_or_update_at_resource_group	insert	resource_group_name, deployment_stack_name, subscription_id		Creates or updates a Deployment stack at the specified scope.
create_or_update_at_subscription	insert	deployment_stack_name, subscription_id		Creates or updates a Deployment stack at the specified scope.
create_or_update_at_management_group	insert	management_group_id, deployment_stack_name		Creates or updates a Deployment stack at the specified scope.
create_or_update_at_resource_group	replace	resource_group_name, deployment_stack_name, subscription_id		Creates or updates a Deployment stack at the specified scope.
create_or_update_at_subscription	replace	deployment_stack_name, subscription_id		Creates or updates a Deployment stack at the specified scope.
create_or_update_at_management_group	replace	management_group_id, deployment_stack_name		Creates or updates a Deployment stack at the specified scope.
delete_at_resource_group	delete	resource_group_name, deployment_stack_name, subscription_id	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.
delete_at_subscription	delete	deployment_stack_name, subscription_id	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.
delete_at_management_group	delete	management_group_id, deployment_stack_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.
validate_stack_at_resource_group	exec	resource_group_name, deployment_stack_name, subscription_id		Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
export_template_at_resource_group	exec	resource_group_name, deployment_stack_name, subscription_id		Exports the template used to create the Deployment stack at the specified scope.
validate_stack_at_subscription	exec	deployment_stack_name, subscription_id		Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
export_template_at_subscription	exec	deployment_stack_name, subscription_id		Exports the template used to create the Deployment stack at the specified scope.
validate_stack_at_management_group	exec	management_group_id, deployment_stack_name		Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
export_template_at_management_group	exec	management_group_id, deployment_stack_name		Exports the template used to create the Deployment stack at the specified scope.

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_stack_name	string	Name of the deployment stack. Required.
management_group_id	string	The management group ID. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
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_at_resource_group

Gets the Deployment stack with the given name.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_stack_name = '{{ deployment_stack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_at_resource_group

Lists Deployment stacks at the specified scope.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_at_subscription

Gets the Deployment stack with the given name.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE deployment_stack_name = '{{ deployment_stack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_at_management_group

Gets the Deployment stack with the given name.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE management_group_id = '{{ management_group_id }}' -- required
AND deployment_stack_name = '{{ deployment_stack_name }}' -- required
;

list_at_subscription

Lists Deployment stacks at the specified scope.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list_at_management_group

Lists Deployment stacks at the specified scope.

SELECT
id,
name,
actionOnUnmanage,
bypassStackOutOfSyncError,
correlationId,
debugSetting,
deletedResources,
denySettings,
deploymentExtensions,
deploymentId,
deploymentScope,
description,
detachedResources,
duration,
error,
extensionConfigs,
externalInputDefinitions,
externalInputs,
failedResources,
location,
outputs,
parameters,
parametersLink,
provisioningState,
resources,
systemData,
tags,
template,
templateLink,
type,
validationLevel
FROM azure.resource.deployment_stacks
WHERE management_group_id = '{{ management_group_id }}' -- required
;

INSERT examples

create_or_update_at_resource_group

Creates or updates a Deployment stack at the specified scope.

INSERT INTO azure.resource.deployment_stacks (
properties,
location,
tags,
resource_group_name,
deployment_stack_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ deployment_stack_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

create_or_update_at_subscription

Creates or updates a Deployment stack at the specified scope.

INSERT INTO azure.resource.deployment_stacks (
properties,
location,
tags,
deployment_stack_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ deployment_stack_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

create_or_update_at_management_group

Creates or updates a Deployment stack at the specified scope.

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

Manifest

# Description fields are for documentation purposes
- name: deployment_stacks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployment_stacks resource.
  - name: deployment_stack_name
    value: "{{ deployment_stack_name }}"
    description: Required parameter for the deployment_stacks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployment_stacks resource.
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the deployment_stacks resource.
  - name: properties
    description: |
      Deployment stack properties.
    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 }}"
      bypassStackOutOfSyncError: {{ bypassStackOutOfSyncError }}
      detachedResources:
        - id: "{{ id }}"
          extension:
            name: "{{ name }}"
            version: "{{ version }}"
            configId: "{{ configId }}"
            config: "{{ config }}"
          type: "{{ type }}"
          identifiers: "{{ identifiers }}"
          apiVersion: "{{ apiVersion }}"
      deletedResources:
        - id: "{{ id }}"
          extension:
            name: "{{ name }}"
            version: "{{ version }}"
            configId: "{{ configId }}"
            config: "{{ config }}"
          type: "{{ type }}"
          identifiers: "{{ identifiers }}"
          apiVersion: "{{ apiVersion }}"
      failedResources:
        - id: "{{ id }}"
          extension:
            name: "{{ name }}"
            version: "{{ version }}"
            configId: "{{ configId }}"
            config: "{{ config }}"
          type: "{{ type }}"
          identifiers: "{{ identifiers }}"
          apiVersion: "{{ apiVersion }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
      resources:
        - id: "{{ id }}"
          extension:
            name: "{{ name }}"
            version: "{{ version }}"
            configId: "{{ configId }}"
            config: "{{ config }}"
          type: "{{ type }}"
          identifiers: "{{ identifiers }}"
          apiVersion: "{{ apiVersion }}"
          status: "{{ status }}"
          denyStatus: "{{ denyStatus }}"
      deploymentExtensions:
        - name: "{{ name }}"
          version: "{{ version }}"
          configId: "{{ configId }}"
          config: "{{ config }}"
      deploymentId: "{{ deploymentId }}"
      outputs: "{{ outputs }}"
      duration: "{{ duration }}"
  - 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_at_resource_group

Creates or updates a Deployment stack at the specified scope.

REPLACE azure.resource.deployment_stacks
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND deployment_stack_name = '{{ deployment_stack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

create_or_update_at_subscription

Creates or updates a Deployment stack at the specified scope.

REPLACE azure.resource.deployment_stacks
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
deployment_stack_name = '{{ deployment_stack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

create_or_update_at_management_group

Creates or updates a Deployment stack at the specified scope.

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

DELETE examples

delete_at_resource_group

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
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND deployment_stack_name = '{{ deployment_stack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND unmanageAction.Resources = '{{ unmanageAction.Resources }}'
AND unmanageAction.ResourceGroups = '{{ unmanageAction.ResourceGroups }}'
AND unmanageAction.ManagementGroups = '{{ unmanageAction.ManagementGroups }}'
AND unmanageAction.ResourcesWithoutDeleteSupport = '{{ unmanageAction.ResourcesWithoutDeleteSupport }}'
AND bypassStackOutOfSyncError = '{{ bypassStackOutOfSyncError }}'
;

delete_at_subscription

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
WHERE deployment_stack_name = '{{ deployment_stack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND unmanageAction.Resources = '{{ unmanageAction.Resources }}'
AND unmanageAction.ResourceGroups = '{{ unmanageAction.ResourceGroups }}'
AND unmanageAction.ManagementGroups = '{{ unmanageAction.ManagementGroups }}'
AND unmanageAction.ResourcesWithoutDeleteSupport = '{{ unmanageAction.ResourcesWithoutDeleteSupport }}'
AND bypassStackOutOfSyncError = '{{ bypassStackOutOfSyncError }}'
;

delete_at_management_group

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
WHERE management_group_id = '{{ management_group_id }}' --required
AND deployment_stack_name = '{{ deployment_stack_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

validate_stack_at_resource_group

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

EXEC azure.resource.deployment_stacks.validate_stack_at_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@deployment_stack_name='{{ deployment_stack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;

export_template_at_resource_group

Exports the template used to create the Deployment stack at the specified scope.

EXEC azure.resource.deployment_stacks.export_template_at_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@deployment_stack_name='{{ deployment_stack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

validate_stack_at_subscription

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

EXEC azure.resource.deployment_stacks.validate_stack_at_subscription 
@deployment_stack_name='{{ deployment_stack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;

export_template_at_subscription

Exports the template used to create the Deployment stack at the specified scope.

EXEC azure.resource.deployment_stacks.export_template_at_subscription 
@deployment_stack_name='{{ deployment_stack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

validate_stack_at_management_group

Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.

EXEC azure.resource.deployment_stacks.validate_stack_at_management_group 
@management_group_id='{{ management_group_id }}' --required, 
@deployment_stack_name='{{ deployment_stack_name }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}"
}'
;

export_template_at_management_group

Exports the template used to create the Deployment stack at the specified scope.

EXEC azure.resource.deployment_stacks.export_template_at_management_group 
@management_group_id='{{ management_group_id }}' --required, 
@deployment_stack_name='{{ deployment_stack_name }}' --required
;