azure.mgmt.resource.deploymentstacks.v2024_03_01.operations module

class azure.mgmt.resource.deploymentstacks.v2024_03_01.operations.DeploymentStacksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DeploymentStacksClient’s deployment_stacks attribute.

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][source]

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

Creates or updates a Deployment stack at Management Group scope.

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Return type:

LROPoller[DeploymentStack]

Raises:

HttpResponseError –

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][source]

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

Creates or updates a Deployment stack at Resource Group scope.

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Return type:

LROPoller[DeploymentStack]

Raises:

HttpResponseError –

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

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

Creates or updates a Deployment stack at Subscription scope.

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStack or the result of cls(response)

Return type:

LROPoller[DeploymentStack]

Raises:

HttpResponseError –

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][source]

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

Parameters:

management_group_id (str) – Management Group id. Required.
deployment_stack_name (str) – Name of the deployment stack. Required.
unmanage_action_resources (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 (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 (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 (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

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][source]

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_stack_name (str) – Name of the deployment stack. Required.
unmanage_action_resources (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 (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 (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 (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

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][source]

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

Parameters:

deployment_stack_name (str) – Name of the deployment stack. Required.
unmanage_action_resources (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 (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 (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 (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

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][source]

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

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

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Return type:

LROPoller[DeploymentStackValidateResult]

Raises:

HttpResponseError –

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][source]

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

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

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Return type:

LROPoller[DeploymentStackValidateResult]

Raises:

HttpResponseError –

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

begin_validate_stack_at_subscription(deployment_stack_name: str, deployment_stack: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DeploymentStackValidateResult]

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

Parameters:

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

Returns:

An instance of LROPoller that returns either DeploymentStackValidateResult or the result of cls(response)

Return type:

LROPoller[DeploymentStackValidateResult]

Raises:

HttpResponseError –

export_template_at_management_group(management_group_id: str, deployment_stack_name: str, **kwargs: Any) → DeploymentStackTemplateDefinition[source]

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

Parameters:

management_group_id (str) – Management Group id. Required.
deployment_stack_name (str) – Name of the deployment stack. Required.

Returns:

DeploymentStackTemplateDefinition or the result of cls(response)

Return type:

DeploymentStackTemplateDefinition

Raises:

HttpResponseError –

export_template_at_resource_group(resource_group_name: str, deployment_stack_name: str, **kwargs: Any) → DeploymentStackTemplateDefinition[source]

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

Parameters:

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

Returns:

DeploymentStackTemplateDefinition or the result of cls(response)

Return type:

DeploymentStackTemplateDefinition

Raises:

HttpResponseError –

export_template_at_subscription(deployment_stack_name: str, **kwargs: Any) → DeploymentStackTemplateDefinition[source]

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

Parameters:: deployment_stack_name (str) – Name of the deployment stack. Required.
Returns:: DeploymentStackTemplateDefinition or the result of cls(response)
Return type:: DeploymentStackTemplateDefinition
Raises:: HttpResponseError –

get_at_management_group(management_group_id: str, deployment_stack_name: str, **kwargs: Any) → DeploymentStack[source]

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

Parameters:

management_group_id (str) – Management Group id. Required.
deployment_stack_name (str) – Name of the deployment stack. Required.

Returns:

DeploymentStack or the result of cls(response)

Return type:

DeploymentStack

Raises:

HttpResponseError –

get_at_resource_group(resource_group_name: str, deployment_stack_name: str, **kwargs: Any) → DeploymentStack[source]

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

Parameters:

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

Returns:

DeploymentStack or the result of cls(response)

Return type:

DeploymentStack

Raises:

HttpResponseError –

get_at_subscription(deployment_stack_name: str, **kwargs: Any) → DeploymentStack[source]

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

Parameters:: deployment_stack_name (str) – Name of the deployment stack. Required.
Returns:: DeploymentStack or the result of cls(response)
Return type:: DeploymentStack
Raises:: HttpResponseError –

list_at_management_group(management_group_id: str, **kwargs: Any) → Iterable[DeploymentStack][source]

Lists all the Deployment stacks within the specified Management Group.

Parameters:: management_group_id (str) – Management Group id. Required.
Returns:: An iterator like instance of either DeploymentStack or the result of cls(response)
Return type:: ItemPaged[DeploymentStack]
Raises:: HttpResponseError –

list_at_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[DeploymentStack][source]

Lists all the Deployment stacks within the specified Resource Group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either DeploymentStack or the result of cls(response)
Return type:: ItemPaged[DeploymentStack]
Raises:: HttpResponseError –

list_at_subscription(**kwargs: Any) → Iterable[DeploymentStack][source]

Lists all the Deployment stacks within the specified Subscription.

Returns:: An iterator like instance of either DeploymentStack or the result of cls(response)
Return type:: ItemPaged[DeploymentStack]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.resource.deploymentstacks.v2024_03_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/resource/deploymentstacks/v2024_03_01/models/__init__.py'>