azure.mgmt.resource.resources.v2016_09_01.models module¶
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
AliasPathType
(*, path: Optional[str] = None, api_versions: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The type of the paths for alias.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
AliasType
(*, name: Optional[str] = None, paths: Optional[List[AliasPathType]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The alias type.
- Parameters
name (str) – The alias name.
paths (list[AliasPathType]) – The paths for an alias.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
BasicDependency
(*, id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment dependency information.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DebugSetting
(*, detail_level: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
DebugSetting.
- Parameters
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.v2016_09_01.models.
Dependency
(*, depends_on: Optional[List[BasicDependency]] = None, id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment dependency information.
- Parameters
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.v2016_09_01.models.
Deployment
(*, properties: azure.mgmt.resource.resources.v2016_09_01.models._models_py3.DeploymentProperties, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation parameters.
All required parameters must be populated in order to send to Azure.
- Parameters
properties (DeploymentProperties) – Required. The deployment properties.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentExportResult
(*, template: object = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The deployment export result.
- Parameters
template (object) – The template content.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentExtended
(*, name: str, properties: Optional[DeploymentPropertiesExtended] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment 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 Azure.
- Variables
- Parameters
name (str) – Required. The name of the deployment.
properties (DeploymentPropertiesExtended) – Deployment properties.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentExtendedFilter
(*, provisioning_state: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment filter.
- Parameters
provisioning_state (str) – The provisioning state.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentListResult
(*, value: Optional[List[DeploymentExtended]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of deployments.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[DeploymentExtended]) – An array of deployments.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentMode
(value)[source]¶ -
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.v2016_09_01.models.
DeploymentOperation
(*, properties: Optional[DeploymentOperationProperties] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
properties (DeploymentOperationProperties) – Deployment properties.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentOperationProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
provisioning_state (str) – The state of the provisioning.
timestamp (datetime) – The date and time of the operation.
service_request_id (str) – Deployment operation service request id.
status_code (str) – Operation status code.
status_message (object) – Operation status message.
target_resource (TargetResource) – The target resource.
request (HttpMessage) – The HTTP request message.
response (HttpMessage) – The HTTP response message.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentOperationsListResult
(*, value: Optional[List[DeploymentOperation]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of deployment operations.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[DeploymentOperation]) – An array of deployment operations.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentProperties
(*, mode: Union[str, DeploymentMode], template: object = None, template_link: Optional[TemplateLink] = None, parameters: object = None, parameters_link: Optional[ParametersLink] = None, debug_setting: Optional[DebugSetting] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment properties.
All required parameters must be populated in order to send to Azure.
- Parameters
template (object) – The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.
template_link (TemplateLink) – The URI of the template. Use either the templateLink property or the template property, but not both.
parameters (object) – 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) – Required. 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. Possible values include: “Incremental”, “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentPropertiesExtended
(*, outputs: object = None, providers: Optional[List[Provider]] = None, dependencies: Optional[List[Dependency]] = None, template: object = None, template_link: Optional[TemplateLink] = None, parameters: object = None, parameters_link: Optional[ParametersLink] = None, mode: Optional[Union[str, DeploymentMode]] = None, debug_setting: Optional[DebugSetting] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment properties with additional details.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
outputs (object) – 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 (object) – The template content. Use only one of Template or TemplateLink.
template_link (TemplateLink) – The URI referencing the template. Use only one of Template or TemplateLink.
parameters (object) – Deployment parameters. Use only one of Parameters or ParametersLink.
parameters_link (ParametersLink) – The URI referencing the parameters. Use only one of Parameters or ParametersLink.
mode (str or DeploymentMode) – The deployment mode. Possible values are Incremental and Complete. Possible values include: “Incremental”, “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
DeploymentValidateResult
(*, error: Optional[ResourceManagementErrorWithDetails] = None, properties: Optional[DeploymentPropertiesExtended] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information from validate template deployment response.
- Parameters
error (ResourceManagementErrorWithDetails) – Validation error.
properties (DeploymentPropertiesExtended) – The template deployment properties.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ErrorAdditionalInfo
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ErrorResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The resource management error response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
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.v2016_09_01.models.
ExportTemplateRequest
(*, resources: Optional[List[str]] = None, options: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Export resource group template request parameters.
- Parameters
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’.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
GenericResource
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, plan: Optional[Plan] = None, properties: object = None, kind: Optional[str] = None, managed_by: Optional[str] = None, sku: Optional[Sku] = None, identity: Optional[Identity] = None, **kwargs)[source]¶ Bases:
azure.mgmt.resource.resources.v2016_09_01.models._models_py3.Resource
Resource information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
location (str) – Resource location.
plan (Plan) – The plan of the resource.
properties (object) – 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.v2016_09_01.models.
GenericResourceExpanded
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, plan: Optional[Plan] = None, properties: object = None, kind: Optional[str] = None, managed_by: Optional[str] = None, sku: Optional[Sku] = None, identity: Optional[Identity] = None, **kwargs)[source]¶ Bases:
azure.mgmt.resource.resources.v2016_09_01.models._models_py3.GenericResource
Resource information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Resource name.
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.
- Parameters
location (str) – Resource location.
plan (Plan) – The plan of the resource.
properties (object) – 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.v2016_09_01.models.
GenericResourceFilter
(*, resource_type: Optional[str] = None, tagname: Optional[str] = None, tagvalue: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource filter.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
HttpMessage
(*, content: object = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
HttpMessage.
- Parameters
content (object) – HTTP message content.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
Identity
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Identity for the resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
type
= 'SystemAssigned'¶
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ParametersLink
(*, uri: str, content_version: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Entity representing the reference to the deployment parameters.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
Plan
(*, name: Optional[str] = None, publisher: Optional[str] = None, product: Optional[str] = None, promotion_code: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Plan for the resource.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
Provider
(*, namespace: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource provider information.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ProviderListResult
(*, value: Optional[List[Provider]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource providers.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ProviderResourceType
(*, resource_type: Optional[str] = None, locations: Optional[List[str]] = None, aliases: Optional[List[AliasType]] = None, api_versions: Optional[List[str]] = None, properties: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource type managed by the resource provider.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
Resource
(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceGroup
(*, location: str, name: Optional[str] = None, properties: Optional[ResourceGroupProperties] = None, managed_by: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.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 Azure.
- Variables
- Parameters
name (str) – The name of the resource group.
properties (ResourceGroupProperties) – The resource group properties.
location (str) – Required. 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.
managed_by (str) – The ID of the resource that manages this resource group.
tags (dict[str, str]) – A set of tags. The tags attached to the resource group.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceGroupExportResult
(*, template: object = None, error: Optional[ResourceManagementErrorWithDetails] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ResourceGroupExportResult.
- Parameters
template (object) – The template content.
error (ResourceManagementErrorWithDetails) – The error.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceGroupFilter
(*, tag_name: Optional[str] = None, tag_value: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource group filter.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceGroupListResult
(*, value: Optional[List[ResourceGroup]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource groups.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[ResourceGroup]) – An array of resource groups.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceGroupProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.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.v2016_09_01.models.
ResourceListResult
(*, value: Optional[List[GenericResourceExpanded]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource groups.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[GenericResourceExpanded]) – An array of resources.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceManagementErrorWithDetails
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ResourceManagementErrorWithDetails.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourceProviderOperationDisplayProperties
(*, publisher: Optional[str] = None, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource provider operation’s display properties.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
ResourcesMoveInfo
(*, resources: Optional[List[str]] = None, target_resource_group: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameters of move resources.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
Sku
(*, name: Optional[str] = None, tier: Optional[str] = None, size: Optional[str] = None, family: Optional[str] = None, model: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SKU for the resource.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
SubResource
(*, id: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SubResource.
- Parameters
id (str) – Resource ID.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TagCount
(*, type: Optional[str] = None, value: Optional[int] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Tag count.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TagDetails
(*, tag_name: Optional[str] = None, count: Optional[TagCount] = None, values: Optional[List[TagValue]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Tag details.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TagValue
(*, tag_value: Optional[str] = None, count: Optional[TagCount] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Tag information.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TagsListResult
(*, value: Optional[List[TagDetails]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of subscription tags.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
value (list[TagDetails]) – An array of tags.
- Variables
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TargetResource
(*, id: Optional[str] = None, resource_name: Optional[str] = None, resource_type: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Target resource.
-
class
azure.mgmt.resource.resources.v2016_09_01.models.
TemplateHashResult
(*, minified_template: Optional[str] = None, template_hash: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Result of the request to calculate template hash. It contains a string of minified template and its hash.