DeploymentStacksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DeploymentStacksClient's

<xref:deployment_stacks> attribute.

Inheritance

builtins.object

DeploymentStacksOperations

Constructor

DeploymentStacksOperations(*args, **kwargs)

Methods

begin_create_or_update_at_management_group	Creates or updates a Deployment stack at Management Group scope.
begin_create_or_update_at_resource_group	Creates or updates a Deployment stack at Resource Group scope.
begin_create_or_update_at_subscription	Creates or updates a Deployment stack at Subscription scope.
begin_delete_at_management_group	Deletes a Deployment stack by name at Management Group scope. When operation completes, status code 200 returned without content.
begin_delete_at_resource_group	Deletes a Deployment stack by name at Resource Group scope. When operation completes, status code 200 returned without content.
begin_delete_at_subscription	Deletes a Deployment stack by name at Subscription scope. When operation completes, status code 200 returned without content.
begin_validate_stack_at_management_group	Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
begin_validate_stack_at_resource_group	Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
begin_validate_stack_at_subscription	Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
export_template_at_management_group	Exports the template used to create the Deployment stack at Management Group scope.
export_template_at_resource_group	Exports the template used to create the Deployment stack at Resource Group scope.
export_template_at_subscription	Exports the template used to create the Deployment stack at Subscription scope.
get_at_management_group	Gets a Deployment stack with a given name at Management Group scope.
get_at_resource_group	Gets a Deployment stack with a given name at Resource Group scope.
get_at_subscription	Gets a Deployment stack with a given name at Subscription scope.
list_at_management_group	Lists all the Deployment stacks within the specified Management Group.
list_at_resource_group	Lists all the Deployment stacks within the specified Resource Group.
list_at_subscription	Lists all the Deployment stacks within the specified Subscription.

begin_create_or_update_at_management_group

Creates or updates a Deployment stack at Management Group scope.

begin_create_or_update_at_management_group(management_group_id: str, deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStack]

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack supplied to the operation. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStack]	An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_at_resource_group

Creates or updates a Deployment stack at Resource Group scope.

begin_create_or_update_at_resource_group(resource_group_name: str, deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStack]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack supplied to the operation. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStack]	An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_at_subscription

Creates or updates a Deployment stack at Subscription scope.

begin_create_or_update_at_subscription(deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStack]

Parameters

Name	Description
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack supplied to the operation. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStack]	An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_at_management_group

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

begin_delete_at_management_group(management_group_id: str, deployment_stack_name: str, unmanage_action_resources: str | UnmanageActionResourceMode | None = None, unmanage_action_resource_groups: str | UnmanageActionResourceGroupMode | None = None, unmanage_action_management_groups: str | UnmanageActionManagementGroupMode | None = None, bypass_stack_out_of_sync_error: bool | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
unmanage_action_resources Required	str or UnmanageActionResourceMode Flag to indicate delete rather than detach for unmanaged resources. Known values are: "delete" and "detach". Default value is None.
unmanage_action_resource_groups Required	str or UnmanageActionResourceGroupMode Flag to indicate delete rather than detach for unmanaged resource groups. Known values are: "delete" and "detach". Default value is None.
unmanage_action_management_groups Required	str or UnmanageActionManagementGroupMode Flag to indicate delete rather than detach for unmanaged management groups. Known values are: "delete" and "detach". Default value is None.
bypass_stack_out_of_sync_error Required	bool Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_at_resource_group

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

begin_delete_at_resource_group(resource_group_name: str, deployment_stack_name: str, unmanage_action_resources: str | UnmanageActionResourceMode | None = None, unmanage_action_resource_groups: str | UnmanageActionResourceGroupMode | None = None, unmanage_action_management_groups: str | UnmanageActionManagementGroupMode | None = None, bypass_stack_out_of_sync_error: bool | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
unmanage_action_resources Required	str or UnmanageActionResourceMode Flag to indicate delete rather than detach for unmanaged resources. Known values are: "delete" and "detach". Default value is None.
unmanage_action_resource_groups Required	str or UnmanageActionResourceGroupMode Flag to indicate delete rather than detach for unmanaged resource groups. Known values are: "delete" and "detach". Default value is None.
unmanage_action_management_groups Required	str or UnmanageActionManagementGroupMode Flag to indicate delete rather than detach for unmanaged management groups. Known values are: "delete" and "detach". Default value is None.
bypass_stack_out_of_sync_error Required	bool Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_at_subscription

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

begin_delete_at_subscription(deployment_stack_name: str, unmanage_action_resources: str | UnmanageActionResourceMode | None = None, unmanage_action_resource_groups: str | UnmanageActionResourceGroupMode | None = None, unmanage_action_management_groups: str | UnmanageActionManagementGroupMode | None = None, bypass_stack_out_of_sync_error: bool | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
deployment_stack_name Required	str Name of the deployment stack. Required.
unmanage_action_resources Required	str or UnmanageActionResourceMode Flag to indicate delete rather than detach for unmanaged resources. Known values are: "delete" and "detach". Default value is None.
unmanage_action_resource_groups Required	str or UnmanageActionResourceGroupMode Flag to indicate delete rather than detach for unmanaged resource groups. Known values are: "delete" and "detach". Default value is None.
unmanage_action_management_groups Required	str or UnmanageActionManagementGroupMode Flag to indicate delete rather than detach for unmanaged management groups. Known values are: "delete" and "detach". Default value is None.
bypass_stack_out_of_sync_error Required	bool Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_stack_at_management_group

Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.

begin_validate_stack_at_management_group(management_group_id: str, deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStackValidateResult]

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack to validate. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStackValidateResult]	An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_stack_at_resource_group

Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.

begin_validate_stack_at_resource_group(resource_group_name: str, deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStackValidateResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack to validate. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStackValidateResult]	An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_validate_stack_at_subscription

Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.

begin_validate_stack_at_subscription(deployment_stack_name: str, deployment_stack: _models.DeploymentStack, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentStackValidateResult]

Parameters

Name	Description
deployment_stack_name Required	str Name of the deployment stack. Required.
deployment_stack Required	DeploymentStack or IO[bytes] Deployment stack to validate. Is either a DeploymentStack type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[DeploymentStackValidateResult]	An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

export_template_at_management_group

Exports the template used to create the Deployment stack at Management Group scope.

export_template_at_management_group(management_group_id: str, deployment_stack_name: str, **kwargs: Any) -> DeploymentStackTemplateDefinition

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStackTemplateDefinition	DeploymentStackTemplateDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

export_template_at_resource_group

Exports the template used to create the Deployment stack at Resource Group scope.

export_template_at_resource_group(resource_group_name: str, deployment_stack_name: str, **kwargs: Any) -> DeploymentStackTemplateDefinition

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStackTemplateDefinition	DeploymentStackTemplateDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

export_template_at_subscription

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

export_template_at_subscription(deployment_stack_name: str, **kwargs: Any) -> DeploymentStackTemplateDefinition

Parameters

Name	Description
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStackTemplateDefinition	DeploymentStackTemplateDefinition or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_management_group

Gets a Deployment stack with a given name at Management Group scope.

get_at_management_group(management_group_id: str, deployment_stack_name: str, **kwargs: Any) -> DeploymentStack

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStack	DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_resource_group

Gets a Deployment stack with a given name at Resource Group scope.

get_at_resource_group(resource_group_name: str, deployment_stack_name: str, **kwargs: Any) -> DeploymentStack

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStack	DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_at_subscription

Gets a Deployment stack with a given name at Subscription scope.

get_at_subscription(deployment_stack_name: str, **kwargs: Any) -> DeploymentStack

Parameters

Name	Description
deployment_stack_name Required	str Name of the deployment stack. Required.

Returns

Type	Description
DeploymentStack	DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_management_group

Lists all the Deployment stacks within the specified Management Group.

list_at_management_group(management_group_id: str, **kwargs: Any) -> Iterable[DeploymentStack]

Parameters

Name	Description
management_group_id Required	str Management Group id. Required.

Returns

Type	Description
ItemPaged[DeploymentStack]	An iterator like instance of either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_resource_group

Lists all the Deployment stacks within the specified Resource Group.

list_at_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DeploymentStack]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[DeploymentStack]	An iterator like instance of either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_at_subscription

Lists all the Deployment stacks within the specified Subscription.

list_at_subscription(**kwargs: Any) -> Iterable[DeploymentStack]

Returns

Type	Description
ItemPaged[DeploymentStack]	An iterator like instance of either DeploymentStack or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.resource.deploymentstacks.v2024_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\deploymentstacks\\v2024_03_01\\models\\__init__.py'>