azure.mgmt.resource.resources.v2016_02_01.models module¶
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
AliasPathType
(*, path: Optional[str] = None, api_versions: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
AliasPathType.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
AliasType
(*, name: Optional[str] = None, paths: Optional[List[AliasPathType]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
AliasType.
- Parameters
name (str) – The alias name.
paths (list[AliasPathType]) – The paths for an alias.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_01.models.
DebugSetting
(*, detail_level: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
DebugSetting.
- Parameters
detail_level (str) – The debug detail level.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_01.models.
Deployment
(*, properties: Optional[DeploymentProperties] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation parameters.
- Parameters
properties (DeploymentProperties) – The deployment properties.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
DeploymentExportResult
(*, template: object = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
DeploymentExportResult.
- Parameters
template (object) – The template content.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_01.models.
DeploymentListResult
(*, value: Optional[List[DeploymentExtended]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of deployments.
- Parameters
value (list[DeploymentExtended]) – The list of deployments.
next_link (str) – The URL to get the next set of results.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
DeploymentMode
(value)[source]¶ -
The deployment mode.
-
complete
= 'Complete'¶
-
incremental
= 'Incremental'¶
-
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
DeploymentOperation
(*, id: Optional[str] = None, operation_id: Optional[str] = None, properties: Optional[DeploymentOperationProperties] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation information.
- Parameters
id (str) – Full deployment operation id.
operation_id (str) – Deployment operation id.
properties (DeploymentOperationProperties) – Deployment properties.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
DeploymentOperationProperties
(*, provisioning_state: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, service_request_id: Optional[str] = None, status_code: Optional[str] = None, status_message: object = None, target_resource: Optional[TargetResource] = None, request: Optional[HttpMessage] = None, response: Optional[HttpMessage] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment operation properties.
- Parameters
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_02_01.models.
DeploymentOperationsListResult
(*, value: Optional[List[DeploymentOperation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of deployment operations.
- Parameters
value (list[DeploymentOperation]) – The list of deployments.
next_link (str) – The URL to get the next set of results.
-
class
azure.mgmt.resource.resources.v2016_02_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. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.
template_link (TemplateLink) – The template URI. Use only one of Template or TemplateLink.
parameters (object) – Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.
parameters_link (ParametersLink) – The parameters URI. Use only one of Parameters or ParametersLink.
mode (str or DeploymentMode) – Required. The deployment mode. Possible values include: “Incremental”, “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
DeploymentPropertiesExtended
(*, provisioning_state: Optional[str] = None, correlation_id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, 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.
- Parameters
provisioning_state (str) – The state of the provisioning.
correlation_id (str) – The correlation ID of the deployment.
timestamp (datetime) – The timestamp of the template deployment.
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 include: “Incremental”, “Complete”.
debug_setting (DebugSetting) – The debug setting of the deployment.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_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_02_01.models.
Provider
(*, id: Optional[str] = None, namespace: Optional[str] = None, registration_state: Optional[str] = None, resource_types: Optional[List[ProviderResourceType]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource provider information.
- Parameters
id (str) – The provider id.
namespace (str) – The namespace of the provider.
registration_state (str) – The registration state of the provider.
resource_types (list[ProviderResourceType]) – The collection of provider resource types.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
ProviderListResult
(*, value: Optional[List[Provider]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource providers.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_01.models.
ResourceGroup
(*, location: str, name: Optional[str] = None, properties: Optional[ResourceGroupProperties] = 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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc.
tags (dict[str, str]) – A set of tags. The tags attached to the resource group.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_01.models.
ResourceGroupListResult
(*, next_link: str, value: Optional[List[ResourceGroup]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource groups.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[ResourceGroup]) – The list of resource groups.
next_link (str) – Required. The URL to get the next set of results.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_01.models.
ResourceListResult
(*, next_link: str, value: Optional[List[GenericResourceExpanded]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of resource groups.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[GenericResourceExpanded]) – The list of resources.
next_link (str) – Required. The URL to get the next set of results.
-
class
azure.mgmt.resource.resources.v2016_02_01.models.
ResourceManagementErrorWithDetails
(*, code: str, message: str, target: Optional[str] = None, details: Optional[List[ResourceManagementErrorWithDetails]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ResourceManagementErrorWithDetails.
All required parameters must be populated in order to send to Azure.
- Parameters
code (str) – Required. The error code returned from the server.
message (str) – Required. The error message returned from the server.
target (str) – The target of the error.
details (list[ResourceManagementErrorWithDetails]) – Validation error.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_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_02_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_02_01.models.
TagCount
(*, type: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Tag count.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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_02_01.models.
TagsListResult
(*, next_link: str, value: Optional[List[TagDetails]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of subscription tags.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[TagDetails]) – The list of tags.
next_link (str) – Required. The URL to get the next set of results.
-
class
azure.mgmt.resource.resources.v2016_02_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_02_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.