azure.mgmt.resource.resources.v2024_07_01.models module

Bases: Model

The alias type.

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

Variables:

name (str) – The alias name.
paths (list[AliasPath]) – The paths for an alias.
type (str or AliasType) – The type of the alias. Known values are: “NotSpecified”, “PlainText”, and “Mask”.
default_path (str) – The default path for an alias.
default_pattern (AliasPattern) – The default pattern for an alias.
default_metadata (AliasPathMetadata) – The default alias path metadata. Applies to the default path and to any alias path that doesn’t have metadata.

Keyword Arguments:

name (str) – The alias name.
paths (list[AliasPath]) – The paths for an alias.
type (str or AliasType) – The type of the alias. Known values are: “NotSpecified”, “PlainText”, and “Mask”.
default_path (str) – The default path for an alias.
default_pattern (AliasPattern) – The default pattern for an alias.

class azure.mgmt.resource.resources.v2024_07_01.models.AliasPath(*, path: str | None = None, api_versions: List[str] | None = None, pattern: _models.AliasPattern | None = None, **kwargs: Any)[source]

Bases: Model

The type of the paths for alias.

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

Variables:

path (str) – The path of an alias.
api_versions (list[str]) – The API versions.
pattern (AliasPattern) – The pattern for an alias path.
metadata (AliasPathMetadata) – The metadata of the alias path. If missing, fall back to the default metadata of the alias.

Keyword Arguments:

path (str) – The path of an alias.
api_versions (list[str]) – The API versions.
pattern (AliasPattern) – The pattern for an alias path.

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

Bases: str, Enum

The attributes of the token that the alias path is referring to.

MODIFIABLE = 'Modifiable': The token that the alias path is referring to is modifiable by policies with ‘modify’ effect.

NONE = 'None': The token that the alias path is referring to has no attributes.

class azure.mgmt.resource.resources.v2024_07_01.models.AliasPathMetadata(**kwargs: Any)[source]

Bases: Model

AliasPathMetadata.

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

Variables:

type (str or AliasPathTokenType) – The type of the token that the alias path is referring to. Known values are: “NotSpecified”, “Any”, “String”, “Object”, “Array”, “Integer”, “Number”, and “Boolean”.
attributes (str or AliasPathAttributes) – The attributes of the token that the alias path is referring to. Known values are: “None” and “Modifiable”.

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

Bases: str, Enum

The type of the token that the alias path is referring to.

ANY = 'Any': The token type can be anything.

ARRAY = 'Array': The token type is array.

BOOLEAN = 'Boolean': The token type is boolean.

INTEGER = 'Integer': The token type is integer.

NOT_SPECIFIED = 'NotSpecified': The token type is not specified.

NUMBER = 'Number': The token type is number.

OBJECT = 'Object': The token type is object.

STRING = 'String': The token type is string.

class azure.mgmt.resource.resources.v2024_07_01.models.AliasPattern(*, phrase: str | None = None, variable: str | None = None, type: str | _models.AliasPatternType | None = None, **kwargs: Any)[source]

Bases: Model

The type of the pattern for an alias path.

Variables:

phrase (str) – The alias pattern phrase.
variable (str) – The alias pattern variable.
type (str or AliasPatternType) – The type of alias pattern. Known values are: “NotSpecified” and “Extract”.

Keyword Arguments:

phrase (str) – The alias pattern phrase.
variable (str) – The alias pattern variable.
type (str or AliasPatternType) – The type of alias pattern. Known values are: “NotSpecified” and “Extract”.

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

Bases: str, Enum

The type of alias pattern.

EXTRACT = 'Extract': Extract is the only allowed value.

NOT_SPECIFIED = 'NotSpecified': NotSpecified is not allowed.

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

Bases: str, Enum

The type of the alias.

MASK = 'Mask': Alias value is secret.

NOT_SPECIFIED = 'NotSpecified': Alias type is unknown (same as not providing alias type).

PLAIN_TEXT = 'PlainText': Alias value is not secret.

class azure.mgmt.resource.resources.v2024_07_01.models.ApiProfile(**kwargs: Any)[source]

Bases: Model

ApiProfile.

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

Variables:

profile_version (str) – The profile version.
api_version (str) – The API version.

class azure.mgmt.resource.resources.v2024_07_01.models.BasicDependency(*, id: str | None = None, resource_type: str | None = None, resource_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment dependency information.

Variables:

id (str) – The ID of the dependency.
resource_type (str) – The dependency resource type.
resource_name (str) – The dependency resource name.

Keyword Arguments:

id (str) – The ID of the dependency.
resource_type (str) – The dependency resource type.
resource_name (str) – The dependency resource name.

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

Bases: str, Enum

Type of change that will be made to the resource when the deployment is executed.

CREATE = 'Create': The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed.

DELETE = 'Delete': The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed.

DEPLOY = 'Deploy': The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change.

IGNORE = 'Ignore': The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed.

MODIFY = 'Modify': The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change.

NO_CHANGE = 'NoChange': The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change.

UNSUPPORTED = 'Unsupported': The resource is not supported by What-If.

class azure.mgmt.resource.resources.v2024_07_01.models.DebugSetting(*, 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 you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.
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 you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.

class azure.mgmt.resource.resources.v2024_07_01.models.Dependency(*, depends_on: List[_models.BasicDependency] | None = None, id: str | None = None, resource_type: str | None = None, resource_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment dependency information.

Variables:

depends_on (list[BasicDependency]) – The list of dependencies.
id (str) – The ID of the dependency.
resource_type (str) – The dependency resource type.
resource_name (str) – The dependency resource name.

Keyword Arguments:

depends_on (list[BasicDependency]) – The list of dependencies.
id (str) – The ID of the dependency.
resource_type (str) – The dependency resource type.
resource_name (str) – The dependency resource name.

class azure.mgmt.resource.resources.v2024_07_01.models.Deployment(*, properties: _models.DeploymentProperties, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Deployment operation parameters.

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

Variables:

location (str) – The location to store the deployment data.
properties (DeploymentProperties) – The deployment properties. Required.
tags (dict[str, str]) – Deployment tags.

Keyword Arguments:

location (str) – The location to store the deployment data.
properties (DeploymentProperties) – The deployment properties. Required.
tags (dict[str, str]) – Deployment tags.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentDiagnosticsDefinition(**kwargs: Any)[source]

Bases: Model

DeploymentDiagnosticsDefinition.

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:

level (str or Level) – Denotes the additional response level. Required. Known values are: “Warning”, “Info”, and “Error”.
code (str) – The error code. Required.
message (str) – The error message. Required.
target (str) – The error target.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentExportResult(*, template: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

The deployment export result.

Variables:: template (JSON) – The template content.
Keyword Arguments:: template (JSON) – The template content.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentExtended(*, location: str | None = None, properties: _models.DeploymentPropertiesExtended | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Deployment information.

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

Variables:

id (str) – The ID of the deployment.
name (str) – The name of the deployment.
type (str) – The type of the deployment.
location (str) – the location of the deployment.
properties (DeploymentPropertiesExtended) – Deployment properties.
tags (dict[str, str]) – Deployment tags.

Keyword Arguments:

location (str) – the location of the deployment.
properties (DeploymentPropertiesExtended) – Deployment properties.
tags (dict[str, str]) – Deployment tags.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentExtendedFilter(*, provisioning_state: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment filter.

Variables:: provisioning_state (str) – The provisioning state.
Keyword Arguments:: provisioning_state (str) – The provisioning state.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentListResult(*, value: List[_models.DeploymentExtended] | None = None, **kwargs: Any)[source]

Bases: Model

List of deployments.

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

Variables:

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

Keyword Arguments:

value (list[DeploymentExtended]) – An array of deployments.

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

Bases: str, Enum

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

COMPLETE = 'Complete'

INCREMENTAL = 'Incremental'

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentOperation(*, properties: _models.DeploymentOperationProperties | None = None, **kwargs: Any)[source]

Bases: Model

Deployment operation information.

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

Variables:

id (str) – Full deployment operation ID.
operation_id (str) – Deployment operation ID.
properties (DeploymentOperationProperties) – Deployment properties.

Keyword Arguments:

properties (DeploymentOperationProperties) – Deployment properties.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentOperationProperties(**kwargs: Any)[source]

Bases: Model

Deployment operation properties.

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

Variables:

provisioning_operation (str or ProvisioningOperation) – The name of the current provisioning operation. Known values are: “NotSpecified”, “Create”, “Delete”, “Waiting”, “AzureAsyncOperationWaiting”, “ResourceCacheWaiting”, “Action”, “Read”, “EvaluateDeploymentOutput”, and “DeploymentCleanup”.
provisioning_state (str) – The state of the provisioning.
timestamp (datetime) – The date and time of the operation.
duration (str) – The duration of the operation.
service_request_id (str) – Deployment operation service request id.
status_code (str) – Operation status code from the resource provider. This property may not be set if a response has not yet been received.
status_message (StatusMessage) – Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider.
target_resource (TargetResource) – The target resource.
request (HttpMessage) – The HTTP request message.
response (HttpMessage) – The HTTP response message.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentOperationsListResult(*, value: List[_models.DeploymentOperation] | None = None, **kwargs: Any)[source]

Bases: Model

List of deployment operations.

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

Variables:

value (list[DeploymentOperation]) – An array of deployment operations.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[DeploymentOperation]) – An array of deployment operations.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentParameter(*, value: Any | 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 .
reference (KeyVaultParameterReference) – Azure Key Vault parameter reference.

Keyword Arguments:

value (any) – Input value to the parameter .
reference (KeyVaultParameterReference) – Azure Key Vault parameter reference.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentProperties(*, mode: str | _models.DeploymentMode, template: MutableMapping[str, Any] | None = None, template_link: _models.TemplateLink | None = None, parameters: Dict[str, _models.DeploymentParameter] | None = None, parameters_link: _models.ParametersLink | None = None, debug_setting: _models.DebugSetting | None = None, on_error_deployment: _models.OnErrorDeployment | None = None, expression_evaluation_options: _models.ExpressionEvaluationOptions | None = None, **kwargs: Any)[source]

Bases: Model

Deployment properties.

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

Variables:

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 (TemplateLink) – 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. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parameters_link (ParametersLink) – The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
mode (str or DeploymentMode) – The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. Required. Known values are: “Incremental” and “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
on_error_deployment (OnErrorDeployment) – The deployment on error behavior.
expression_evaluation_options (ExpressionEvaluationOptions) – Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.

Keyword Arguments:

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 (TemplateLink) – 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. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parameters_link (ParametersLink) – The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
mode (str or DeploymentMode) – The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. Required. Known values are: “Incremental” and “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
on_error_deployment (OnErrorDeployment) – The deployment on error behavior.
expression_evaluation_options (ExpressionEvaluationOptions) – Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentPropertiesExtended(**kwargs: Any)[source]

Bases: Model

Deployment properties with additional details.

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

Variables:

provisioning_state (str or ProvisioningState) – Denotes the state of provisioning. Known values are: “NotSpecified”, “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
correlation_id (str) – The correlation ID of the deployment.
timestamp (datetime) – The timestamp of the template deployment.
duration (str) – The duration of the template deployment.
outputs (JSON) – Key/value pairs that represent deployment output.
providers (list[Provider]) – The list of resource providers needed for the deployment.
dependencies (list[Dependency]) – The list of deployment dependencies.
template_link (TemplateLink) – The URI referencing the template.
parameters (JSON) – Deployment parameters.
parameters_link (ParametersLink) – The URI referencing the parameters.
mode (str or DeploymentMode) – The deployment mode. Possible values are Incremental and Complete. Known values are: “Incremental” and “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
on_error_deployment (OnErrorDeploymentExtended) – The deployment on error behavior.
template_hash (str) – The hash produced for the template.
output_resources (list[ResourceReference]) – Array of provisioned resources.
validated_resources (list[ResourceReference]) – Array of validated resources.
error (ErrorResponse) – The deployment error.
diagnostics (list[DeploymentDiagnosticsDefinition]) – Contains diagnostic information collected during validation process.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentValidateResult(*, properties: _models.DeploymentPropertiesExtended | None = None, **kwargs: Any)[source]

Bases: Model

Information from validate template deployment response.

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

Variables:

error (ErrorResponse) – The deployment validation error.
id (str) – The ID of the deployment.
name (str) – The name of the deployment.
type (str) – The type of the deployment.
properties (DeploymentPropertiesExtended) – The template deployment properties.

Keyword Arguments:

properties (DeploymentPropertiesExtended) – The template deployment properties.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentWhatIf(*, properties: _models.DeploymentWhatIfProperties, location: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment What-if operation parameters.

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

Variables:

location (str) – The location to store the deployment data.
properties (DeploymentWhatIfProperties) – The deployment properties. Required.

Keyword Arguments:

location (str) – The location to store the deployment data.
properties (DeploymentWhatIfProperties) – The deployment properties. Required.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentWhatIfProperties(*, mode: str | _models.DeploymentMode, template: MutableMapping[str, Any] | None = None, template_link: _models.TemplateLink | None = None, parameters: Dict[str, _models.DeploymentParameter] | None = None, parameters_link: _models.ParametersLink | None = None, debug_setting: _models.DebugSetting | None = None, on_error_deployment: _models.OnErrorDeployment | None = None, expression_evaluation_options: _models.ExpressionEvaluationOptions | None = None, what_if_settings: _models.DeploymentWhatIfSettings | None = None, **kwargs: Any)[source]

Bases: DeploymentProperties

Deployment What-if properties.

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

Variables:

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 (TemplateLink) – 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. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parameters_link (ParametersLink) – The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
mode (str or DeploymentMode) – The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. Required. Known values are: “Incremental” and “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
on_error_deployment (OnErrorDeployment) – The deployment on error behavior.
expression_evaluation_options (ExpressionEvaluationOptions) – Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.
what_if_settings (DeploymentWhatIfSettings) – Optional What-If operation settings.

Keyword Arguments:

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 (TemplateLink) – 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. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.
parameters_link (ParametersLink) – The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.
mode (str or DeploymentMode) – The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. Required. Known values are: “Incremental” and “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
on_error_deployment (OnErrorDeployment) – The deployment on error behavior.
expression_evaluation_options (ExpressionEvaluationOptions) – Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer.
what_if_settings (DeploymentWhatIfSettings) – Optional What-If operation settings.

class azure.mgmt.resource.resources.v2024_07_01.models.DeploymentWhatIfSettings(*, result_format: str | _models.WhatIfResultFormat | None = None, **kwargs: Any)[source]

Bases: Model

Deployment What-If operation settings.

Variables:: result_format (str or WhatIfResultFormat) – The format of the What-If results. Known values are: “ResourceIdOnly” and “FullResourcePayloads”.
Keyword Arguments:: result_format (str or WhatIfResultFormat) – The format of the What-If results. Known values are: “ResourceIdOnly” and “FullResourcePayloads”.

class azure.mgmt.resource.resources.v2024_07_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.resources.v2024_07_01.models.ErrorResponse(**kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

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[ErrorResponse]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

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

Bases: str, Enum

The output format for the exported resources.

BICEP = 'Bicep'

JSON = 'Json'

class azure.mgmt.resource.resources.v2024_07_01.models.ExportTemplateRequest(*, resources: List[str] | None = None, options: str | None = None, output_format: str | _models.ExportTemplateOutputFormat | None = None, **kwargs: Any)[source]

Bases: Model

Export resource group template request parameters.

Variables:

resources (list[str]) – The IDs of the resources to filter the export by. To export all resources, supply an array with single entry ‘*’.
options (str) – The export template options. A CSV-formatted list containing zero or more of the following: ‘IncludeParameterDefaultValue’, ‘IncludeComments’, ‘SkipResourceNameParameterization’, ‘SkipAllParameterization’.
output_format (str or ExportTemplateOutputFormat) – The output format for the exported resources. Known values are: “Json” and “Bicep”.

Keyword Arguments:

resources (list[str]) – The IDs of the resources to filter the export by. To export all resources, supply an array with single entry ‘*’.
options (str) – The export template options. A CSV-formatted list containing zero or more of the following: ‘IncludeParameterDefaultValue’, ‘IncludeComments’, ‘SkipResourceNameParameterization’, ‘SkipAllParameterization’.
output_format (str or ExportTemplateOutputFormat) – The output format for the exported resources. Known values are: “Json” and “Bicep”.

class azure.mgmt.resource.resources.v2024_07_01.models.ExpressionEvaluationOptions(*, scope: str | _models.ExpressionEvaluationOptionsScopeType | None = None, **kwargs: Any)[source]

Bases: Model

Specifies whether template expressions are evaluated within the scope of the parent template or nested template.

Variables:: scope (str or ExpressionEvaluationOptionsScopeType) – The scope to be used for evaluation of parameters, variables and functions in a nested template. Known values are: “NotSpecified”, “Outer”, and “Inner”.
Keyword Arguments:: scope (str or ExpressionEvaluationOptionsScopeType) – The scope to be used for evaluation of parameters, variables and functions in a nested template. Known values are: “NotSpecified”, “Outer”, and “Inner”.

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

Bases: str, Enum

The scope to be used for evaluation of parameters, variables and functions in a nested template.

INNER = 'Inner'

NOT_SPECIFIED = 'NotSpecified'

OUTER = 'Outer'

class azure.mgmt.resource.resources.v2024_07_01.models.ExtendedLocation(*, type: str | _models.ExtendedLocationType | None = None, name: str | None = None, **kwargs: Any)[source]

Bases: Model

Resource extended location.

Variables:

type (str or ExtendedLocationType) – The extended location type. “EdgeZone”
name (str) – The extended location name.

Keyword Arguments:

type (str or ExtendedLocationType) – The extended location type. “EdgeZone”
name (str) – The extended location name.

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

Bases: str, Enum

The extended location type.

EDGE_ZONE = 'EdgeZone'

class azure.mgmt.resource.resources.v2024_07_01.models.GenericResource(*, location: str | None = None, extended_location: _models.ExtendedLocation | None = None, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, properties: MutableMapping[str, Any] | None = None, kind: str | None = None, managed_by: str | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, **kwargs: Any)[source]

Bases: Resource

Resource information.

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

Variables:

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.
plan (Plan) – The plan of the resource.
properties (JSON) – The resource properties.
kind (str) – The kind of the resource.
managed_by (str) – ID of the resource that manages this resource.
sku (Sku) – The SKU of the resource.
identity (Identity) – The identity of the resource.

Keyword Arguments:

location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.
plan (Plan) – The plan of the resource.
properties (JSON) – The resource properties.
kind (str) – The kind of the resource.
managed_by (str) – ID of the resource that manages this resource.
sku (Sku) – The SKU of the resource.
identity (Identity) – The identity of the resource.

class azure.mgmt.resource.resources.v2024_07_01.models.GenericResourceExpanded(*, location: str | None = None, extended_location: _models.ExtendedLocation | None = None, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, properties: MutableMapping[str, Any] | None = None, kind: str | None = None, managed_by: str | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, **kwargs: Any)[source]

Bases: GenericResource

Resource information.

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

Variables:

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.
plan (Plan) – The plan of the resource.
properties (JSON) – The resource properties.
kind (str) – The kind of the resource.
managed_by (str) – ID of the resource that manages this resource.
sku (Sku) – The SKU of the resource.
identity (Identity) – The identity of the resource.
created_time (datetime) – The created time of the resource. This is only present if requested via the $expand query parameter.
changed_time (datetime) – The changed time of the resource. This is only present if requested via the $expand query parameter.
provisioning_state (str) – The provisioning state of the resource. This is only present if requested via the $expand query parameter.

Keyword Arguments:

location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.
plan (Plan) – The plan of the resource.
properties (JSON) – The resource properties.
kind (str) – The kind of the resource.
managed_by (str) – ID of the resource that manages this resource.
sku (Sku) – The SKU of the resource.
identity (Identity) – The identity of the resource.

class azure.mgmt.resource.resources.v2024_07_01.models.GenericResourceFilter(*, resource_type: str | None = None, tagname: str | None = None, tagvalue: str | None = None, **kwargs: Any)[source]

Bases: Model

Resource filter.

Variables:

resource_type (str) – The resource type.
tagname (str) – The tag name.
tagvalue (str) – The tag value.

Keyword Arguments:

resource_type (str) – The resource type.
tagname (str) – The tag name.
tagvalue (str) – The tag value.

class azure.mgmt.resource.resources.v2024_07_01.models.HttpMessage(*, content: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

HTTP message.

Variables:: content (JSON) – HTTP message content.
Keyword Arguments:: content (JSON) – HTTP message content.

class azure.mgmt.resource.resources.v2024_07_01.models.Identity(*, type: str | _models.ResourceIdentityType | None = None, user_assigned_identities: Dict[str, _models.IdentityUserAssignedIdentitiesValue] | None = None, **kwargs: Any)[source]

Bases: Model

Identity for the resource.

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

Variables:

principal_id (str) – The principal ID of resource identity.
tenant_id (str) – The tenant ID of resource.
type (str or ResourceIdentityType) – The identity type. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, IdentityUserAssignedIdentitiesValue]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

Keyword Arguments:

type (str or ResourceIdentityType) – The identity type. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, IdentityUserAssignedIdentitiesValue]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

class azure.mgmt.resource.resources.v2024_07_01.models.IdentityUserAssignedIdentitiesValue(**kwargs: Any)[source]

Bases: Model

IdentityUserAssignedIdentitiesValue.

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

Variables:

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.resource.resources.v2024_07_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.resources.v2024_07_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 resource id. Required.
Keyword Arguments:: id (str) – Azure Key Vault resource id. Required.

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

Bases: str, Enum

Denotes the additional response level.

ERROR = 'Error'

INFO = 'Info'

WARNING = 'Warning'

class azure.mgmt.resource.resources.v2024_07_01.models.OnErrorDeployment(*, type: str | _models.OnErrorDeploymentType | None = None, deployment_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment on error behavior.

Variables:

type (str or OnErrorDeploymentType) – The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Known values are: “LastSuccessful” and “SpecificDeployment”.
deployment_name (str) – The deployment to be used on error case.

Keyword Arguments:

type (str or OnErrorDeploymentType) – The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Known values are: “LastSuccessful” and “SpecificDeployment”.
deployment_name (str) – The deployment to be used on error case.

class azure.mgmt.resource.resources.v2024_07_01.models.OnErrorDeploymentExtended(*, type: str | _models.OnErrorDeploymentType | None = None, deployment_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Deployment on error behavior with additional details.

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

Variables:

provisioning_state (str) – The state of the provisioning for the on error deployment.
type (str or OnErrorDeploymentType) – The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Known values are: “LastSuccessful” and “SpecificDeployment”.
deployment_name (str) – The deployment to be used on error case.

Keyword Arguments:

type (str or OnErrorDeploymentType) – The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. Known values are: “LastSuccessful” and “SpecificDeployment”.
deployment_name (str) – The deployment to be used on error case.

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

Bases: str, Enum

The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

LAST_SUCCESSFUL = 'LastSuccessful'

SPECIFIC_DEPLOYMENT = 'SpecificDeployment'

class azure.mgmt.resource.resources.v2024_07_01.models.Operation(*, name: str | None = None, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

Microsoft.Resources operation.

Variables:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

Keyword Arguments:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.resource.resources.v2024_07_01.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

The object that represents the operation.

Variables:

provider (str) – Service provider: Microsoft.Resources.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of the operation.

Keyword Arguments:

provider (str) – Service provider: Microsoft.Resources.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of the operation.

class azure.mgmt.resource.resources.v2024_07_01.models.OperationListResult(*, value: List[_models.Operation] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.

Variables:

value (list[Operation]) – List of Microsoft.Resources operations.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments:

value (list[Operation]) – List of Microsoft.Resources operations.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.resource.resources.v2024_07_01.models.ParametersLink(*, 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.resources.v2024_07_01.models.Permission(*, actions: List[str] | None = None, not_actions: List[str] | None = None, data_actions: List[str] | None = None, not_data_actions: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Role definition permissions.

Variables:

actions (list[str]) – Allowed actions.
not_actions (list[str]) – Denied actions.
data_actions (list[str]) – Allowed Data actions.
not_data_actions (list[str]) – Denied Data actions.

Keyword Arguments:

actions (list[str]) – Allowed actions.
not_actions (list[str]) – Denied actions.
data_actions (list[str]) – Allowed Data actions.
not_data_actions (list[str]) – Denied Data actions.

Bases: Model

Plan for the resource.

Variables:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – The offer ID.
promotion_code (str) – The promotion code.
version (str) – The plan’s version.

Keyword Arguments:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – The offer ID.
promotion_code (str) – The promotion code.
version (str) – The plan’s version.

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

Bases: str, Enum

The type of property change.

ARRAY = 'Array': The property is an array and contains nested changes.

CREATE = 'Create': The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed.

DELETE = 'Delete': The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed.

MODIFY = 'Modify': The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed.

NO_EFFECT = 'NoEffect': The property will not be set or updated.

class azure.mgmt.resource.resources.v2024_07_01.models.Provider(*, namespace: str | None = None, provider_authorization_consent_state: str | _models.ProviderAuthorizationConsentState | None = None, **kwargs: Any)[source]

Bases: Model

Resource provider information.

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

Variables:

id (str) – The provider ID.
namespace (str) – The namespace of the resource provider.
registration_state (str) – The registration state of the resource provider.
registration_policy (str) – The registration policy of the resource provider.
resource_types (list[ProviderResourceType]) – The collection of provider resource types.
provider_authorization_consent_state (str or ProviderAuthorizationConsentState) – The provider authorization consent state. Known values are: “NotSpecified”, “Required”, “NotRequired”, and “Consented”.

Keyword Arguments:

namespace (str) – The namespace of the resource provider.
provider_authorization_consent_state (str or ProviderAuthorizationConsentState) – The provider authorization consent state. Known values are: “NotSpecified”, “Required”, “NotRequired”, and “Consented”.

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

Bases: str, Enum

The provider authorization consent state.

CONSENTED = 'Consented'

NOT_REQUIRED = 'NotRequired'

NOT_SPECIFIED = 'NotSpecified'

REQUIRED = 'Required'

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderConsentDefinition(*, consent_to_authorization: bool | None = None, **kwargs: Any)[source]

Bases: Model

The provider consent.

Variables:: consent_to_authorization (bool) – A value indicating whether authorization is consented or not.
Keyword Arguments:: consent_to_authorization (bool) – A value indicating whether authorization is consented or not.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderExtendedLocation(*, location: str | None = None, type: str | None = None, extended_locations: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The provider extended location.

Variables:

location (str) – The azure location.
type (str) – The extended location type.
extended_locations (list[str]) – The extended locations for the azure location.

Keyword Arguments:

location (str) – The azure location.
type (str) – The extended location type.
extended_locations (list[str]) – The extended locations for the azure location.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderListResult(*, value: List[_models.Provider] | None = None, **kwargs: Any)[source]

Bases: Model

List of resource providers.

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

Variables:

value (list[Provider]) – An array of resource providers.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[Provider]) – An array of resource providers.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderPermission(*, application_id: str | None = None, role_definition: _models.RoleDefinition | None = None, managed_by_role_definition: _models.RoleDefinition | None = None, provider_authorization_consent_state: str | _models.ProviderAuthorizationConsentState | None = None, **kwargs: Any)[source]

Bases: Model

The provider permission.

Variables:

application_id (str) – The application id.
role_definition (RoleDefinition) – Role definition properties.
managed_by_role_definition (RoleDefinition) – Role definition properties.
provider_authorization_consent_state (str or ProviderAuthorizationConsentState) – The provider authorization consent state. Known values are: “NotSpecified”, “Required”, “NotRequired”, and “Consented”.

Keyword Arguments:

application_id (str) – The application id.
role_definition (RoleDefinition) – Role definition properties.
managed_by_role_definition (RoleDefinition) – Role definition properties.
provider_authorization_consent_state (str or ProviderAuthorizationConsentState) – The provider authorization consent state. Known values are: “NotSpecified”, “Required”, “NotRequired”, and “Consented”.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderPermissionListResult(*, value: List[_models.ProviderPermission] | None = None, **kwargs: Any)[source]

Bases: Model

List of provider permissions.

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

Variables:

value (list[ProviderPermission]) – An array of provider permissions.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[ProviderPermission]) – An array of provider permissions.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderRegistrationRequest(*, third_party_provider_consent: _models.ProviderConsentDefinition | None = None, **kwargs: Any)[source]

Bases: Model

The provider registration definition.

Variables:: third_party_provider_consent (ProviderConsentDefinition) – The provider consent.
Keyword Arguments:: third_party_provider_consent (ProviderConsentDefinition) – The provider consent.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderResourceType(*, resource_type: str | None = None, locations: List[str] | None = None, location_mappings: List[_models.ProviderExtendedLocation] | None = None, aliases: List[_models.Alias] | None = None, api_versions: List[str] | None = None, zone_mappings: List[_models.ZoneMapping] | None = None, capabilities: str | None = None, properties: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Resource type managed by the resource provider.

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

Variables:

resource_type (str) – The resource type.
locations (list[str]) – The collection of locations where this resource type can be created.
location_mappings (list[ProviderExtendedLocation]) – The location mappings that are supported by this resource type.
aliases (list[Alias]) – The aliases that are supported by this resource type.
api_versions (list[str]) – The API version.
default_api_version (str) – The default API version.
zone_mappings (list[ZoneMapping])
api_profiles (list[ApiProfile]) – The API profiles for the resource provider.
capabilities (str) – The additional capabilities offered by this resource type.
properties (dict[str, str]) – The properties.

Keyword Arguments:

resource_type (str) – The resource type.
locations (list[str]) – The collection of locations where this resource type can be created.
location_mappings (list[ProviderExtendedLocation]) – The location mappings that are supported by this resource type.
aliases (list[Alias]) – The aliases that are supported by this resource type.
api_versions (list[str]) – The API version.
zone_mappings (list[ZoneMapping])
capabilities (str) – The additional capabilities offered by this resource type.
properties (dict[str, str]) – The properties.

class azure.mgmt.resource.resources.v2024_07_01.models.ProviderResourceTypeListResult(*, value: List[_models.ProviderResourceType] | None = None, **kwargs: Any)[source]

Bases: Model

List of resource types of a resource provider.

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

Variables:

value (list[ProviderResourceType]) – An array of resource types.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[ProviderResourceType]) – An array of resource types.

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

Bases: str, Enum

The name of the current provisioning operation.

ACTION = 'Action': The provisioning operation is action.

AZURE_ASYNC_OPERATION_WAITING = 'AzureAsyncOperationWaiting': The provisioning operation is waiting Azure async operation.

CREATE = 'Create': The provisioning operation is create.

DELETE = 'Delete': The provisioning operation is delete.

DEPLOYMENT_CLEANUP = 'DeploymentCleanup': The provisioning operation is cleanup. This operation is part of the ‘complete’ mode deployment.

EVALUATE_DEPLOYMENT_OUTPUT = 'EvaluateDeploymentOutput': The provisioning operation is evaluate output.

NOT_SPECIFIED = 'NotSpecified': The provisioning operation is not specified.

READ = 'Read': The provisioning operation is read.

RESOURCE_CACHE_WAITING = 'ResourceCacheWaiting': The provisioning operation is waiting for resource cache.

WAITING = 'Waiting': The provisioning operation is waiting.

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

Bases: str, Enum

Denotes the state of provisioning.

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

CREATED = 'Created'

CREATING = 'Creating'

DELETED = 'Deleted'

DELETING = 'Deleting'

FAILED = 'Failed'

NOT_SPECIFIED = 'NotSpecified'

READY = 'Ready'

RUNNING = 'Running'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.resource.resources.v2024_07_01.models.Resource(*, location: str | None = None, extended_location: _models.ExtendedLocation | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Specified resource.

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

Variables:

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location.
extended_location (ExtendedLocation) – Resource extended location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroup(*, location: str, properties: _models.ResourceGroupProperties | None = None, managed_by: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Resource group information.

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:

id (str) – The ID of the resource group.
name (str) – The name of the resource group.
type (str) – The type of the resource group.
properties (ResourceGroupProperties) – The resource group properties.
location (str) – The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. Required.
managed_by (str) – The ID of the resource that manages this resource group.
tags (dict[str, str]) – The tags attached to the resource group.

Keyword Arguments:

properties (ResourceGroupProperties) – The resource group properties.
location (str) – The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. Required.
managed_by (str) – The ID of the resource that manages this resource group.
tags (dict[str, str]) – The tags attached to the resource group.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroupExportResult(*, template: MutableMapping[str, Any] | None = None, output: str | None = None, error: _models.ErrorResponse | None = None, **kwargs: Any)[source]

Bases: Model

Resource group export result.

Variables:

template (JSON) – The template content. Used if outputFormat is empty or set to ‘Json’.
output (str) – The formatted export content. Used if outputFormat is set to ‘Bicep’.
error (ErrorResponse) – The template export error.

Keyword Arguments:

template (JSON) – The template content. Used if outputFormat is empty or set to ‘Json’.
output (str) – The formatted export content. Used if outputFormat is set to ‘Bicep’.
error (ErrorResponse) – The template export error.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroupFilter(*, tag_name: str | None = None, tag_value: str | None = None, **kwargs: Any)[source]

Bases: Model

Resource group filter.

Variables:

tag_name (str) – The tag name.
tag_value (str) – The tag value.

Keyword Arguments:

tag_name (str) – The tag name.
tag_value (str) – The tag value.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroupListResult(*, value: List[_models.ResourceGroup] | None = None, **kwargs: Any)[source]

Bases: Model

List of resource groups.

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

Variables:

value (list[ResourceGroup]) – An array of resource groups.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[ResourceGroup]) – An array of resource groups.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroupPatchable(*, name: str | None = None, properties: _models.ResourceGroupProperties | None = None, managed_by: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Resource group information.

Variables:

name (str) – The name of the resource group.
properties (ResourceGroupProperties) – The resource group properties.
managed_by (str) – The ID of the resource that manages this resource group.
tags (dict[str, str]) – The tags attached to the resource group.

Keyword Arguments:

name (str) – The name of the resource group.
properties (ResourceGroupProperties) – The resource group properties.
managed_by (str) – The ID of the resource that manages this resource group.
tags (dict[str, str]) – The tags attached to the resource group.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceGroupProperties(**kwargs: Any)[source]

Bases: Model

The resource group properties.

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

Variables:: provisioning_state (str) – The provisioning state.

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

Bases: str, Enum

The identity type.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceListResult(*, value: List[_models.GenericResourceExpanded] | None = None, **kwargs: Any)[source]

Bases: Model

List of resource groups.

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

Variables:

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

Keyword Arguments:

value (list[GenericResourceExpanded]) – An array of resources.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourceProviderOperationDisplayProperties(*, publisher: str | None = None, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Resource provider operation’s display properties.

Variables:

publisher (str) – Operation description.
provider (str) – Operation provider.
resource (str) – Operation resource.
operation (str) – Resource provider operation.
description (str) – Operation description.

Keyword Arguments:

publisher (str) – Operation description.
provider (str) – Operation provider.
resource (str) – Operation resource.
operation (str) – Resource provider operation.
description (str) – Operation description.

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

Bases: Model

The resource Id model.

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

Variables:: id (str) – The fully qualified resource Id.

class azure.mgmt.resource.resources.v2024_07_01.models.ResourcesMoveInfo(*, resources: List[str] | None = None, target_resource_group: str | None = None, **kwargs: Any)[source]

Bases: Model

Parameters of move resources.

Variables:

resources (list[str]) – The IDs of the resources.
target_resource_group (str) – The target resource group.

Keyword Arguments:

resources (list[str]) – The IDs of the resources.
target_resource_group (str) – The target resource group.

class azure.mgmt.resource.resources.v2024_07_01.models.RoleDefinition(*, id: str | None = None, name: str | None = None, is_service_role: bool | None = None, permissions: List[_models.Permission] | None = None, scopes: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Role definition properties.

Variables:

id (str) – The role definition ID.
name (str) – The role definition name.
is_service_role (bool) – If this is a service role.
permissions (list[Permission]) – Role definition permissions.
scopes (list[str]) – Role definition assignable scopes.

Keyword Arguments:

id (str) – The role definition ID.
name (str) – The role definition name.
is_service_role (bool) – If this is a service role.
permissions (list[Permission]) – Role definition permissions.
scopes (list[str]) – Role definition assignable scopes.

class azure.mgmt.resource.resources.v2024_07_01.models.ScopedDeployment(*, location: str, properties: _models.DeploymentProperties, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Deployment operation parameters.

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

Variables:

location (str) – The location to store the deployment data. Required.
properties (DeploymentProperties) – The deployment properties. Required.
tags (dict[str, str]) – Deployment tags.

Keyword Arguments:

location (str) – The location to store the deployment data. Required.
properties (DeploymentProperties) – The deployment properties. Required.
tags (dict[str, str]) – Deployment tags.

class azure.mgmt.resource.resources.v2024_07_01.models.ScopedDeploymentWhatIf(*, location: str, properties: _models.DeploymentWhatIfProperties, **kwargs: Any)[source]

Bases: Model

Deployment What-if operation parameters.

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

Variables:

location (str) – The location to store the deployment data. Required.
properties (DeploymentWhatIfProperties) – The deployment properties. Required.

Keyword Arguments:

location (str) – The location to store the deployment data. Required.
properties (DeploymentWhatIfProperties) – The deployment properties. Required.

Bases: Model

SKU for the resource.

Variables:

name (str) – The SKU name.
tier (str) – The SKU tier.
size (str) – The SKU size.
family (str) – The SKU family.
model (str) – The SKU model.
capacity (int) – The SKU capacity.

Keyword Arguments:

name (str) – The SKU name.
tier (str) – The SKU tier.
size (str) – The SKU size.
family (str) – The SKU family.
model (str) – The SKU model.
capacity (int) – The SKU capacity.

class azure.mgmt.resource.resources.v2024_07_01.models.StatusMessage(*, status: str | None = None, error: _models.ErrorResponse | None = None, **kwargs: Any)[source]

Bases: Model

Operation status message object.

Variables:

status (str) – Status of the deployment operation.
error (ErrorResponse) – The error reported by the operation.

Keyword Arguments:

status (str) – Status of the deployment operation.
error (ErrorResponse) – The error reported by the operation.

class azure.mgmt.resource.resources.v2024_07_01.models.SubResource(*, id: str | None = None, **kwargs: Any)[source]

Bases: Model

Sub-resource.

Variables:: id (str) – Resource ID.
Keyword Arguments:: id (str) – Resource ID.

class azure.mgmt.resource.resources.v2024_07_01.models.TagCount(*, type: str | None = None, value: int | None = None, **kwargs: Any)[source]

Bases: Model

Tag count.

Variables:

type (str) – Type of count.
value (int) – Value of count.

Keyword Arguments:

type (str) – Type of count.
value (int) – Value of count.

class azure.mgmt.resource.resources.v2024_07_01.models.TagDetails(*, tag_name: str | None = None, count: _models.TagCount | None = None, values: List[_models.TagValue] | None = None, **kwargs: Any)[source]

Bases: Model

Tag details.

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

Variables:

id (str) – The tag name ID.
tag_name (str) – The tag name.
count (TagCount) – The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0.
values (list[TagValue]) – The list of tag values.

Keyword Arguments:

tag_name (str) – The tag name.
count (TagCount) – The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0.
values (list[TagValue]) – The list of tag values.

class azure.mgmt.resource.resources.v2024_07_01.models.TagValue(*, tag_value: str | None = None, count: _models.TagCount | None = None, **kwargs: Any)[source]

Bases: Model

Tag information.

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

Variables:

id (str) – The tag value ID.
tag_value (str) – The tag value.
count (TagCount) – The tag value count.

Keyword Arguments:

tag_value (str) – The tag value.
count (TagCount) – The tag value count.

class azure.mgmt.resource.resources.v2024_07_01.models.Tags(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

A dictionary of name and value pairs.

Variables:: tags (dict[str, str]) – Dictionary of <string>.
Keyword Arguments:: tags (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.resource.resources.v2024_07_01.models.TagsListResult(*, value: List[_models.TagDetails] | None = None, **kwargs: Any)[source]

Bases: Model

List of subscription tags.

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

Variables:

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

Keyword Arguments:

value (list[TagDetails]) – An array of tags.

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

Bases: str, Enum

The operation type for the patch API.

DELETE = 'Delete': The ‘delete’ option allows selectively deleting tags based on given names or name/value pairs.

MERGE = 'Merge': The ‘merge’ option allows adding tags with new names and updating the values of tags with existing names.

REPLACE = 'Replace': The ‘replace’ option replaces the entire set of existing tags with a new set.

class azure.mgmt.resource.resources.v2024_07_01.models.TagsPatchResource(*, operation: str | _models.TagsPatchOperation | None = None, properties: _models.Tags | None = None, **kwargs: Any)[source]

Bases: Model

Wrapper resource for tags patch API request only.

Variables:

operation (str or TagsPatchOperation) – The operation type for the patch API. Known values are: “Replace”, “Merge”, and “Delete”.
properties (Tags) – The set of tags.

Keyword Arguments:

operation (str or TagsPatchOperation) – The operation type for the patch API. Known values are: “Replace”, “Merge”, and “Delete”.
properties (Tags) – The set of tags.

class azure.mgmt.resource.resources.v2024_07_01.models.TagsResource(*, properties: _models.Tags, **kwargs: Any)[source]

Bases: Model

Wrapper resource for tags API requests and responses.

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:

id (str) – The ID of the tags wrapper resource.
name (str) – The name of the tags wrapper resource.
type (str) – The type of the tags wrapper resource.
properties (Tags) – The set of tags. Required.

Keyword Arguments:

properties (Tags) – The set of tags. Required.

class azure.mgmt.resource.resources.v2024_07_01.models.TargetResource(*, id: str | None = None, resource_name: str | None = None, resource_type: str | None = None, **kwargs: Any)[source]

Bases: Model

Target resource.

Variables:

id (str) – The ID of the resource.
resource_name (str) – The name of the resource.
resource_type (str) – The type of the resource.

Keyword Arguments:

id (str) – The ID of the resource.
resource_name (str) – The name of the resource.
resource_type (str) – The type of the resource.

class azure.mgmt.resource.resources.v2024_07_01.models.TemplateHashResult(*, minified_template: str | None = None, template_hash: str | None = None, **kwargs: Any)[source]

Bases: Model

Result of the request to calculate template hash. It contains a string of minified template and its hash.

Variables:

minified_template (str) – The minified template string.
template_hash (str) – The template hash.

Keyword Arguments:

minified_template (str) – The minified template string.
template_hash (str) – The template hash.

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 resource id 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.
content_version (str) – If included, must match the ContentVersion in the template.
query_string (str) – The query string (for example, a SAS token) to be used with the templateLink URI.

Keyword Arguments:

uri (str) – The URI of the template to deploy. Use either the uri or id property, but not both.
id (str) – The resource id 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.
content_version (str) – If included, must match the ContentVersion in the template.
query_string (str) – The query string (for example, a SAS token) to be used with the templateLink URI.

class azure.mgmt.resource.resources.v2024_07_01.models.WhatIfChange(*, resource_id: str, change_type: str | _models.ChangeType, unsupported_reason: str | None = None, before: MutableMapping[str, Any] | None = None, after: MutableMapping[str, Any] | None = None, delta: List[_models.WhatIfPropertyChange] | None = None, **kwargs: Any)[source]

Bases: Model

Information about a single resource change predicted by What-If operation.

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

Variables:

resource_id (str) – Resource ID. Required.
change_type (str or ChangeType) – Type of change that will be made to the resource when the deployment is executed. Required. Known values are: “Create”, “Delete”, “Ignore”, “Deploy”, “NoChange”, “Modify”, and “Unsupported”.
unsupported_reason (str) – The explanation about why the resource is unsupported by What-If.
before (JSON) – The snapshot of the resource before the deployment is executed.
after (JSON) – The predicted snapshot of the resource after the deployment is executed.
delta (list[WhatIfPropertyChange]) – The predicted changes to resource properties.

Keyword Arguments:

resource_id (str) – Resource ID. Required.
change_type (str or ChangeType) – Type of change that will be made to the resource when the deployment is executed. Required. Known values are: “Create”, “Delete”, “Ignore”, “Deploy”, “NoChange”, “Modify”, and “Unsupported”.
unsupported_reason (str) – The explanation about why the resource is unsupported by What-If.
before (JSON) – The snapshot of the resource before the deployment is executed.
after (JSON) – The predicted snapshot of the resource after the deployment is executed.
delta (list[WhatIfPropertyChange]) – The predicted changes to resource properties.

class azure.mgmt.resource.resources.v2024_07_01.models.WhatIfOperationResult(*, status: str | None = None, error: _models.ErrorResponse | None = None, changes: List[_models.WhatIfChange] | None = None, potential_changes: List[_models.WhatIfChange] | None = None, **kwargs: Any)[source]

Bases: Model

Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.

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

Variables:

status (str) – Status of the What-If operation.
error (ErrorResponse) – Error when What-If operation fails.
changes (list[WhatIfChange]) – List of resource changes predicted by What-If operation.
potential_changes (list[WhatIfChange]) – List of resource changes predicted by What-If operation.
diagnostics (list[DeploymentDiagnosticsDefinition]) – List of resource diagnostics detected by What-If operation.

Keyword Arguments:

status (str) – Status of the What-If operation.
error (ErrorResponse) – Error when What-If operation fails.
changes (list[WhatIfChange]) – List of resource changes predicted by What-If operation.
potential_changes (list[WhatIfChange]) – List of resource changes predicted by What-If operation.

class azure.mgmt.resource.resources.v2024_07_01.models.WhatIfPropertyChange(*, path: str, property_change_type: str | _models.PropertyChangeType, before: MutableMapping[str, Any] | None = None, after: MutableMapping[str, Any] | None = None, children: List[_models.WhatIfPropertyChange] | None = None, **kwargs: Any)[source]

Bases: Model

The predicted change to the resource property.

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

Variables:

path (str) – The path of the property. Required.
property_change_type (str or PropertyChangeType) – The type of property change. Required. Known values are: “Create”, “Delete”, “Modify”, “Array”, and “NoEffect”.
before (JSON) – The value of the property before the deployment is executed.
after (JSON) – The value of the property after the deployment is executed.
children (list[WhatIfPropertyChange]) – Nested property changes.

Keyword Arguments:

path (str) – The path of the property. Required.
property_change_type (str or PropertyChangeType) – The type of property change. Required. Known values are: “Create”, “Delete”, “Modify”, “Array”, and “NoEffect”.
before (JSON) – The value of the property before the deployment is executed.
after (JSON) – The value of the property after the deployment is executed.
children (list[WhatIfPropertyChange]) – Nested property changes.

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

Bases: str, Enum

The format of the What-If results.

FULL_RESOURCE_PAYLOADS = 'FullResourcePayloads'

RESOURCE_ID_ONLY = 'ResourceIdOnly'

class azure.mgmt.resource.resources.v2024_07_01.models.ZoneMapping(*, location: str | None = None, zones: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

ZoneMapping.

Variables:

location (str) – The location of the zone mapping.
zones (list[str])

Keyword Arguments:

location (str) – The location of the zone mapping.
zones (list[str])