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

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ActionOnUnmanage(*, resources: str | _models.DeploymentStacksDeleteDetachEnum, resource_groups: str | _models.DeploymentStacksDeleteDetachEnum | None = None, management_groups: str | _models.DeploymentStacksDeleteDetachEnum | None = None, **kwargs: Any)[source]

Bases: Model

Defines the behavior of resources that are no longer managed after the stack is updated or deleted.

All required parameters must be populated in order to send to server.

Variables:

resources (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Required. Known values are: “delete” and “detach”.
resource_groups (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Known values are: “delete” and “detach”.
management_groups (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Known values are: “delete” and “detach”.

Keyword Arguments:

resources (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Required. Known values are: “delete” and “detach”.
resource_groups (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Known values are: “delete” and “detach”.
management_groups (str or DeploymentStacksDeleteDetachEnum) – Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state. Known values are: “delete” and “detach”.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.AzureResourceBase(**kwargs: Any)[source]

Bases: Model

Common properties for all Azure resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – String Id used to locate any resource on Azure.
name (str) – Name of this resource.
type (str) – Type of this resource.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DenySettings(*, mode: str | _models.DenySettingsMode, excluded_principals: List[str] | None = None, excluded_actions: List[str] | None = None, apply_to_child_scopes: bool | None = None, **kwargs: Any)[source]

Bases: Model

Defines how resources deployed by the Deployment stack are locked.

All required parameters must be populated in order to send to server.

Variables:

mode (str or DenySettingsMode) – denySettings Mode that defines denied actions. Required. Known values are: “denyDelete”, “denyWriteAndDelete”, and “none”.
excluded_principals (list[str]) – List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted.
excluded_actions (list[str]) – List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to ‘denyWriteAndDelete’, then the following actions are automatically appended to ‘excludedActions’: ‘*/read’ and ‘Microsoft.Authorization/locks/delete’. If the denySetting mode is set to ‘denyDelete’, then the following actions are automatically appended to ‘excludedActions’: ‘Microsoft.Authorization/locks/delete’. Duplicate actions will be removed.
apply_to_child_scopes (bool) – DenySettings will be applied to child resource scopes of every managed resource with a deny assignment.

Keyword Arguments:

mode (str or DenySettingsMode) – denySettings Mode that defines denied actions. Required. Known values are: “denyDelete”, “denyWriteAndDelete”, and “none”.
excluded_principals (list[str]) – List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted.
excluded_actions (list[str]) – List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to ‘denyWriteAndDelete’, then the following actions are automatically appended to ‘excludedActions’: ‘*/read’ and ‘Microsoft.Authorization/locks/delete’. If the denySetting mode is set to ‘denyDelete’, then the following actions are automatically appended to ‘excludedActions’: ‘Microsoft.Authorization/locks/delete’. Duplicate actions will be removed.
apply_to_child_scopes (bool) – DenySettings will be applied to child resource scopes of every managed resource with a deny assignment.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DenySettingsMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

denySettings Mode that defines denied actions.

DENY_DELETE = 'denyDelete': Authorized users are able to read and modify the resources, but cannot delete.

DENY_WRITE_AND_DELETE = 'denyWriteAndDelete': Authorized users can read from a resource, but cannot modify or delete it.

NONE = 'none': No denyAssignments have been applied.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DenyStatusMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

denyAssignment settings applied to the resource.

DENY_DELETE = 'denyDelete': Authorized users are able to read and modify the resources, but cannot delete.

DENY_WRITE_AND_DELETE = 'denyWriteAndDelete': Authorized users can only read from a resource, but cannot modify or delete it.

INAPPLICABLE = 'inapplicable': denyAssignments are not supported on resources outside the scope of the deployment stack.

NONE = 'none': No denyAssignments have been applied.

NOT_SUPPORTED = 'notSupported': Resource type does not support denyAssignments.

REMOVED_BY_SYSTEM = 'removedBySystem': Deny assignment has been removed by Azure due to a resource management change (management group move, etc.)

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentParameter(*, value: Any | None = None, type: str | None = None, reference: _models.KeyVaultParameterReference | None = None, **kwargs: Any)[source]

Bases: Model

Deployment parameter for the template.

Variables:

value (any) – Input value to the parameter.
type (str) – Type of the value.
reference (KeyVaultParameterReference) – Azure Key Vault parameter reference.

Keyword Arguments:

value (any) – Input value to the parameter.
type (str) – Type of the value.
reference (KeyVaultParameterReference) – Azure Key Vault parameter reference.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStack(*, location: str | None = None, tags: Dict[str, str] | None = None, error: _models.ErrorDetail | None = None, template: MutableMapping[str, Any] | None = None, template_link: _models.DeploymentStacksTemplateLink | None = None, parameters: Dict[str, _models.DeploymentParameter] | None = None, parameters_link: _models.DeploymentStacksParametersLink | None = None, action_on_unmanage: _models.ActionOnUnmanage | None = None, debug_setting: _models.DeploymentStacksDebugSetting | None = None, bypass_stack_out_of_sync_error: bool | None = None, deployment_scope: str | None = None, description: str | None = None, deny_settings: _models.DenySettings | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Deployment stack object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – String Id used to locate any resource on Azure.
name (str) – Name of this resource.
type (str) – Type of this resource.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations.
tags (dict[str, str]) – Deployment stack resource tags.
error (ErrorDetail) – The error detail.
template (JSON) – 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.
parameters (dict[str, DeploymentParameter]) – 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.
parameters_link (DeploymentStacksParametersLink) – 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.
action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
debug_setting (DeploymentStacksDebugSetting) – The debug setting of the deployment.
bypass_stack_out_of_sync_error (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
deployment_scope (str) – 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 (str) – Deployment stack description. Max length of 4096 characters.
deny_settings (DenySettings) – Defines how resources deployed by the stack are locked.
provisioning_state (str or DeploymentStackProvisioningState) – State of the deployment stack. Known values are: “creating”, “validating”, “waiting”, “deploying”, “canceling”, “updatingDenyAssignments”, “deletingResources”, “succeeded”, “failed”, “canceled”, and “deleting”.
correlation_id (str) – The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
detached_resources (list[ResourceReference]) – 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.
deleted_resources (list[ResourceReference]) – 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.
failed_resources (list[ResourceReferenceExtended]) – An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
resources (list[ManagedResourceReference]) – An array of resources currently managed by the deployment stack.
deployment_id (str) – The resourceId of the deployment resource created by the deployment stack.
outputs (JSON) – The outputs of the deployment resource created by the deployment stack.
duration (str) – The duration of the last successful Deployment stack update.

Keyword Arguments:

location (str) – The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations.
tags (dict[str, str]) – Deployment stack resource tags.
error (ErrorDetail) – The error detail.
template (JSON) – 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.
parameters (dict[str, DeploymentParameter]) – 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.
parameters_link (DeploymentStacksParametersLink) – 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.
action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
debug_setting (DeploymentStacksDebugSetting) – The debug setting of the deployment.
bypass_stack_out_of_sync_error (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
deployment_scope (str) – 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 (str) – Deployment stack description. Max length of 4096 characters.
deny_settings (DenySettings) – Defines how resources deployed by the stack are locked.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackListResult(*, value: List[_models.DeploymentStack] | None = None, **kwargs: Any)[source]

Bases: Model

List of Deployment stacks.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[DeploymentStack]) – An array of Deployment stacks.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[DeploymentStack]) – An array of Deployment stacks.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackProperties(*, action_on_unmanage: _models.ActionOnUnmanage, deny_settings: _models.DenySettings, error: _models.ErrorDetail | None = None, template: MutableMapping[str, Any] | None = None, template_link: _models.DeploymentStacksTemplateLink | None = None, parameters: Dict[str, _models.DeploymentParameter] | None = None, parameters_link: _models.DeploymentStacksParametersLink | None = None, debug_setting: _models.DeploymentStacksDebugSetting | None = None, bypass_stack_out_of_sync_error: bool | None = None, deployment_scope: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: DeploymentStacksError

Deployment stack properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

error (ErrorDetail) – The error detail.
template (JSON) – 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.
parameters (dict[str, DeploymentParameter]) – 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.
parameters_link (DeploymentStacksParametersLink) – 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.
action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. Required.
debug_setting (DeploymentStacksDebugSetting) – The debug setting of the deployment.
bypass_stack_out_of_sync_error (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
deployment_scope (str) – 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 (str) – Deployment stack description. Max length of 4096 characters.
deny_settings (DenySettings) – Defines how resources deployed by the stack are locked. Required.
provisioning_state (str or DeploymentStackProvisioningState) – State of the deployment stack. Known values are: “creating”, “validating”, “waiting”, “deploying”, “canceling”, “updatingDenyAssignments”, “deletingResources”, “succeeded”, “failed”, “canceled”, and “deleting”.
correlation_id (str) – The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.
detached_resources (list[ResourceReference]) – 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.
deleted_resources (list[ResourceReference]) – 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.
failed_resources (list[ResourceReferenceExtended]) – An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.
resources (list[ManagedResourceReference]) – An array of resources currently managed by the deployment stack.
deployment_id (str) – The resourceId of the deployment resource created by the deployment stack.
outputs (JSON) – The outputs of the deployment resource created by the deployment stack.
duration (str) – The duration of the last successful Deployment stack update.

Keyword Arguments:

error (ErrorDetail) – The error detail.
template (JSON) – 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.
parameters (dict[str, DeploymentParameter]) – 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.
parameters_link (DeploymentStacksParametersLink) – 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.
action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. Required.
debug_setting (DeploymentStacksDebugSetting) – The debug setting of the deployment.
bypass_stack_out_of_sync_error (bool) – Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
deployment_scope (str) – 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 (str) – Deployment stack description. Max length of 4096 characters.
deny_settings (DenySettings) – Defines how resources deployed by the stack are locked. Required.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

State of the deployment stack.

CANCELED = 'canceled'

CANCELING = 'canceling'

CREATING = 'creating'

DELETING = 'deleting'

DELETING_RESOURCES = 'deletingResources'

DEPLOYING = 'deploying'

FAILED = 'failed'

SUCCEEDED = 'succeeded'

UPDATING_DENY_ASSIGNMENTS = 'updatingDenyAssignments'

VALIDATING = 'validating'

WAITING = 'waiting'

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackTemplateDefinition(*, template: MutableMapping[str, Any] | None = None, template_link: _models.DeploymentStacksTemplateLink | None = None, **kwargs: Any)[source]

Bases: Model

Export Template specific properties of the Deployment stack.

Variables:

template (JSON) – The template content. Use this element 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.

Keyword Arguments:

template (JSON) – The template content. Use this element 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.
template_link (DeploymentStacksTemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackValidateProperties(*, action_on_unmanage: _models.ActionOnUnmanage | None = None, correlation_id: str | None = None, deny_settings: _models.DenySettings | None = None, deployment_scope: str | None = None, description: str | None = None, parameters: Dict[str, _models.DeploymentParameter] | None = None, template_link: _models.DeploymentStacksTemplateLink | None = None, validated_resources: List[_models.ResourceReference] | None = None, **kwargs: Any)[source]

Bases: Model

The Deployment stack validation result details.

Variables:

action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
correlation_id (str) – The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing.
deny_settings (DenySettings) – The Deployment stack deny settings.
deployment_scope (str) – The Deployment stack deployment scope.
description (str) – The Deployment stack validation description.
parameters (dict[str, DeploymentParameter]) – Deployment parameters.
template_link (DeploymentStacksTemplateLink) – The URI of the template.
validated_resources (list[ResourceReference]) – The array of resources that were validated.

Keyword Arguments:

action_on_unmanage (ActionOnUnmanage) – Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
correlation_id (str) – The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing.
deny_settings (DenySettings) – The Deployment stack deny settings.
deployment_scope (str) – The Deployment stack deployment scope.
description (str) – The Deployment stack validation description.
parameters (dict[str, DeploymentParameter]) – Deployment parameters.
template_link (DeploymentStacksTemplateLink) – The URI of the template.
validated_resources (list[ResourceReference]) – The array of resources that were validated.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStackValidateResult(*, error: _models.ErrorDetail | None = None, properties: _models.DeploymentStackValidateProperties | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase, DeploymentStacksError

The Deployment stack validation result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

error (ErrorDetail) – The error detail.
id (str) – String Id used to locate any resource on Azure.
name (str) – Name of this resource.
type (str) – Type of this resource.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (DeploymentStackValidateProperties) – The validation result details.

Keyword Arguments:

error (ErrorDetail) – The error detail.
properties (DeploymentStackValidateProperties) – The validation result details.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStacksDebugSetting(*, detail_level: str | None = None, **kwargs: Any)[source]

Bases: Model

The debug setting.

Variables:: detail_level (str) – Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed.
Keyword Arguments:: detail_level (str) – Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStacksDeleteDetachEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it’s current state.

DELETE = 'delete'

DETACH = 'detach'

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStacksError(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Deployment Stacks error response.

Variables:: error (ErrorDetail) – The error detail.
Keyword Arguments:: error (ErrorDetail) – The error detail.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStacksParametersLink(*, uri: str, content_version: str | None = None, **kwargs: Any)[source]

Bases: Model

Entity representing the reference to the deployment parameters.

All required parameters must be populated in order to send to server.

Variables:

uri (str) – The URI of the parameters file. Required.
content_version (str) – If included, must match the ContentVersion in the template.

Keyword Arguments:

uri (str) – The URI of the parameters file. Required.
content_version (str) – If included, must match the ContentVersion in the template.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.DeploymentStacksTemplateLink(*, uri: str | None = None, id: str | None = None, relative_path: str | None = None, query_string: str | None = None, content_version: str | None = None, **kwargs: Any)[source]

Bases: Model

Entity representing the reference to the template.

Variables:

uri (str) – The URI of the template to deploy. Use either the uri or id property, but not both.
id (str) – The resourceId of a Template Spec. Use either the id or uri property, but not both.
relative_path (str) – The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs.
query_string (str) – The query string (for example, a SAS token) to be used with the templateLink URI.
content_version (str) – If included, must match the ContentVersion in the template.

Keyword Arguments:

uri (str) – The URI of the template to deploy. Use either the uri or id property, but not both.
id (str) – The resourceId of a Template Spec. Use either the id or uri property, but not both.
relative_path (str) – The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs.
query_string (str) – The query string (for example, a SAS token) to be used with the templateLink URI.
content_version (str) – If included, must match the ContentVersion in the template.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.KeyVaultParameterReference(*, key_vault: _models.KeyVaultReference, secret_name: str, secret_version: str | None = None, **kwargs: Any)[source]

Bases: Model

Azure Key Vault parameter reference.

All required parameters must be populated in order to send to server.

Variables:

key_vault (KeyVaultReference) – Azure Key Vault reference. Required.
secret_name (str) – Azure Key Vault secret name. Required.
secret_version (str) – Azure Key Vault secret version.

Keyword Arguments:

key_vault (KeyVaultReference) – Azure Key Vault reference. Required.
secret_name (str) – Azure Key Vault secret name. Required.
secret_version (str) – Azure Key Vault secret version.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.KeyVaultReference(*, id: str, **kwargs: Any)[source]

Bases: Model

Azure Key Vault reference.

All required parameters must be populated in order to send to server.

Variables:: id (str) – Azure Key Vault resourceId. Required.
Keyword Arguments:: id (str) – Azure Key Vault resourceId. Required.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ManagedResourceReference(*, status: str | _models.ResourceStatusMode | None = None, deny_status: str | _models.DenyStatusMode = 'none', **kwargs: Any)[source]

Bases: ResourceReference

The managed resource model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The resourceId of a resource managed by the deployment stack.
status (str or ResourceStatusMode) – Current management state of the resource in the deployment stack. Known values are: “managed”, “removeDenyFailed”, and “deleteFailed”.
deny_status (str or DenyStatusMode) – denyAssignment settings applied to the resource. Known values are: “denyDelete”, “notSupported”, “inapplicable”, “denyWriteAndDelete”, “removedBySystem”, and “none”.

Keyword Arguments:

status (str or ResourceStatusMode) – Current management state of the resource in the deployment stack. Known values are: “managed”, “removeDenyFailed”, and “deleteFailed”.
deny_status (str or DenyStatusMode) – denyAssignment settings applied to the resource. Known values are: “denyDelete”, “notSupported”, “inapplicable”, “denyWriteAndDelete”, “removedBySystem”, and “none”.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ResourceReference(**kwargs: Any)[source]

Bases: Model

The resourceId model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: id (str) – The resourceId of a resource managed by the deployment stack.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ResourceReferenceExtended(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: ResourceReference, DeploymentStacksError

The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

error (ErrorDetail) – The error detail.
id (str) – The resourceId of a resource managed by the deployment stack.

Keyword Arguments:

error (ErrorDetail) – The error detail.

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.ResourceStatusMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Current management state of the resource in the deployment stack.

DELETE_FAILED = 'deleteFailed': Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually.

MANAGED = 'managed': This resource is managed by the deployment stack.

REMOVE_DENY_FAILED = 'removeDenyFailed': Unable to remove the deny assignment on resource.

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.UnmanageActionManagementGroupMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

UnmanageActionManagementGroupMode.

DELETE = 'delete'

DETACH = 'detach'

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.UnmanageActionResourceGroupMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

UnmanageActionResourceGroupMode.

DELETE = 'delete'

DETACH = 'detach'

class azure.mgmt.resource.deploymentstacks.v2024_03_01.models.UnmanageActionResourceMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

UnmanageActionResourceMode.

DELETE = 'delete'

DETACH = 'detach'