# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
import sys
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from ... import _serialization
if sys.version_info >= (3, 9):
from collections.abc import MutableMapping
else:
from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports
if sys.version_info >= (3, 8):
from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports
else:
from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object
[docs]class AccessUri(_serialization.Model):
"""A disk access SAS uri.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar access_sas: A SAS uri for accessing a disk.
:vartype access_sas: str
"""
_validation = {
"access_sas": {"readonly": True},
}
_attribute_map = {
"access_sas": {"key": "accessSAS", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.access_sas = None
[docs]class AdditionalCapabilities(_serialization.Model):
"""Enables or disables a capability on the virtual machine or virtual machine scale set.
:ivar ultra_ssd_enabled: The flag that enables or disables a capability to have one or more
managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with
storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale
set only if this property is enabled.
:vartype ultra_ssd_enabled: bool
"""
_attribute_map = {
"ultra_ssd_enabled": {"key": "ultraSSDEnabled", "type": "bool"},
}
def __init__(self, *, ultra_ssd_enabled: Optional[bool] = None, **kwargs: Any) -> None:
"""
:keyword ultra_ssd_enabled: The flag that enables or disables a capability to have one or more
managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with
storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale
set only if this property is enabled.
:paramtype ultra_ssd_enabled: bool
"""
super().__init__(**kwargs)
self.ultra_ssd_enabled = ultra_ssd_enabled
[docs]class AdditionalUnattendContent(_serialization.Model):
"""Specifies additional XML formatted information that can be included in the Unattend.xml file,
which is used by Windows Setup. Contents are defined by setting name, component name, and the
pass in which the content is applied.
:ivar pass_name: The pass name. Currently, the only allowable value is OobeSystem. Default
value is "OobeSystem".
:vartype pass_name: str
:ivar component_name: The component name. Currently, the only allowable value is
Microsoft-Windows-Shell-Setup. Default value is "Microsoft-Windows-Shell-Setup".
:vartype component_name: str
:ivar setting_name: Specifies the name of the setting to which the content applies. Possible
values are: FirstLogonCommands and AutoLogon. Known values are: "AutoLogon" and
"FirstLogonCommands".
:vartype setting_name: str or ~azure.mgmt.compute.v2019_03_01.models.SettingNames
:ivar content: Specifies the XML formatted content that is added to the unattend.xml file for
the specified path and component. The XML must be less than 4KB and must include the root
element for the setting or feature that is being inserted.
:vartype content: str
"""
_attribute_map = {
"pass_name": {"key": "passName", "type": "str"},
"component_name": {"key": "componentName", "type": "str"},
"setting_name": {"key": "settingName", "type": "str"},
"content": {"key": "content", "type": "str"},
}
def __init__(
self,
*,
pass_name: Optional[Literal["OobeSystem"]] = None,
component_name: Optional[Literal["Microsoft-Windows-Shell-Setup"]] = None,
setting_name: Optional[Union[str, "_models.SettingNames"]] = None,
content: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword pass_name: The pass name. Currently, the only allowable value is OobeSystem. Default
value is "OobeSystem".
:paramtype pass_name: str
:keyword component_name: The component name. Currently, the only allowable value is
Microsoft-Windows-Shell-Setup. Default value is "Microsoft-Windows-Shell-Setup".
:paramtype component_name: str
:keyword setting_name: Specifies the name of the setting to which the content applies. Possible
values are: FirstLogonCommands and AutoLogon. Known values are: "AutoLogon" and
"FirstLogonCommands".
:paramtype setting_name: str or ~azure.mgmt.compute.v2019_03_01.models.SettingNames
:keyword content: Specifies the XML formatted content that is added to the unattend.xml file
for the specified path and component. The XML must be less than 4KB and must include the root
element for the setting or feature that is being inserted.
:paramtype content: str
"""
super().__init__(**kwargs)
self.pass_name = pass_name
self.component_name = component_name
self.setting_name = setting_name
self.content = content
[docs]class ApiEntityReference(_serialization.Model):
"""The API entity reference.
:ivar id: The ARM resource id in the form of
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
:vartype id: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: Optional[str] = None, **kwargs: Any) -> None: # pylint: disable=redefined-builtin
"""
:keyword id: The ARM resource id in the form of
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
:paramtype id: str
"""
super().__init__(**kwargs)
self.id = id
[docs]class ApiError(_serialization.Model):
"""Api error.
:ivar details: The Api error details.
:vartype details: list[~azure.mgmt.compute.v2019_03_01.models.ApiErrorBase]
:ivar innererror: The Api inner error.
:vartype innererror: ~azure.mgmt.compute.v2019_03_01.models.InnerError
:ivar code: The error code.
:vartype code: str
:ivar target: The target of the particular error.
:vartype target: str
:ivar message: The error message.
:vartype message: str
"""
_attribute_map = {
"details": {"key": "details", "type": "[ApiErrorBase]"},
"innererror": {"key": "innererror", "type": "InnerError"},
"code": {"key": "code", "type": "str"},
"target": {"key": "target", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(
self,
*,
details: Optional[List["_models.ApiErrorBase"]] = None,
innererror: Optional["_models.InnerError"] = None,
code: Optional[str] = None,
target: Optional[str] = None,
message: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword details: The Api error details.
:paramtype details: list[~azure.mgmt.compute.v2019_03_01.models.ApiErrorBase]
:keyword innererror: The Api inner error.
:paramtype innererror: ~azure.mgmt.compute.v2019_03_01.models.InnerError
:keyword code: The error code.
:paramtype code: str
:keyword target: The target of the particular error.
:paramtype target: str
:keyword message: The error message.
:paramtype message: str
"""
super().__init__(**kwargs)
self.details = details
self.innererror = innererror
self.code = code
self.target = target
self.message = message
[docs]class ApiErrorBase(_serialization.Model):
"""Api error base.
:ivar code: The error code.
:vartype code: str
:ivar target: The target of the particular error.
:vartype target: str
:ivar message: The error message.
:vartype message: str
"""
_attribute_map = {
"code": {"key": "code", "type": "str"},
"target": {"key": "target", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(
self, *, code: Optional[str] = None, target: Optional[str] = None, message: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword code: The error code.
:paramtype code: str
:keyword target: The target of the particular error.
:paramtype target: str
:keyword message: The error message.
:paramtype message: str
"""
super().__init__(**kwargs)
self.code = code
self.target = target
self.message = message
[docs]class AutomaticOSUpgradePolicy(_serialization.Model):
"""The configuration parameters used for performing automatic OS upgrade.
:ivar enable_automatic_os_upgrade: Indicates whether OS upgrades should automatically be
applied to scale set instances in a rolling fashion when a newer version of the OS image
becomes available. Default value is false. :code:`<br>`:code:`<br>` If this is set to true for
Windows based scale sets, `enableAutomaticUpdates
<https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet>`_
is automatically set to false and cannot be set to true.
:vartype enable_automatic_os_upgrade: bool
:ivar disable_automatic_rollback: Whether OS image rollback feature should be disabled. Default
value is false.
:vartype disable_automatic_rollback: bool
"""
_attribute_map = {
"enable_automatic_os_upgrade": {"key": "enableAutomaticOSUpgrade", "type": "bool"},
"disable_automatic_rollback": {"key": "disableAutomaticRollback", "type": "bool"},
}
def __init__(
self,
*,
enable_automatic_os_upgrade: Optional[bool] = None,
disable_automatic_rollback: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword enable_automatic_os_upgrade: Indicates whether OS upgrades should automatically be
applied to scale set instances in a rolling fashion when a newer version of the OS image
becomes available. Default value is false. :code:`<br>`:code:`<br>` If this is set to true for
Windows based scale sets, `enableAutomaticUpdates
<https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet>`_
is automatically set to false and cannot be set to true.
:paramtype enable_automatic_os_upgrade: bool
:keyword disable_automatic_rollback: Whether OS image rollback feature should be disabled.
Default value is false.
:paramtype disable_automatic_rollback: bool
"""
super().__init__(**kwargs)
self.enable_automatic_os_upgrade = enable_automatic_os_upgrade
self.disable_automatic_rollback = disable_automatic_rollback
[docs]class AutomaticOSUpgradeProperties(_serialization.Model):
"""Describes automatic OS upgrade properties on the image.
All required parameters must be populated in order to send to Azure.
:ivar automatic_os_upgrade_supported: Specifies whether automatic OS upgrade is supported on
the image. Required.
:vartype automatic_os_upgrade_supported: bool
"""
_validation = {
"automatic_os_upgrade_supported": {"required": True},
}
_attribute_map = {
"automatic_os_upgrade_supported": {"key": "automaticOSUpgradeSupported", "type": "bool"},
}
def __init__(self, *, automatic_os_upgrade_supported: bool, **kwargs: Any) -> None:
"""
:keyword automatic_os_upgrade_supported: Specifies whether automatic OS upgrade is supported on
the image. Required.
:paramtype automatic_os_upgrade_supported: bool
"""
super().__init__(**kwargs)
self.automatic_os_upgrade_supported = automatic_os_upgrade_supported
[docs]class AutomaticRepairsPolicy(_serialization.Model):
"""Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
:ivar enabled: Specifies whether automatic repairs should be enabled on the virtual machine
scale set. The default value is false.
:vartype enabled: bool
:ivar grace_period: The amount of time for which automatic repairs are suspended due to a state
change on VM. The grace time starts after the state change has completed. This helps avoid
premature or accidental repairs. The time duration should be specified in ISO 8601 format. The
minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The
maximum allowed grace period is 90 minutes (PT90M).
:vartype grace_period: str
"""
_attribute_map = {
"enabled": {"key": "enabled", "type": "bool"},
"grace_period": {"key": "gracePeriod", "type": "str"},
}
def __init__(self, *, enabled: Optional[bool] = None, grace_period: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword enabled: Specifies whether automatic repairs should be enabled on the virtual machine
scale set. The default value is false.
:paramtype enabled: bool
:keyword grace_period: The amount of time for which automatic repairs are suspended due to a
state change on VM. The grace time starts after the state change has completed. This helps
avoid premature or accidental repairs. The time duration should be specified in ISO 8601
format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default
value. The maximum allowed grace period is 90 minutes (PT90M).
:paramtype grace_period: str
"""
super().__init__(**kwargs)
self.enabled = enabled
self.grace_period = grace_period
[docs]class Resource(_serialization.Model):
"""The Resource model definition.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
[docs]class AvailabilitySet(Resource): # pylint: disable=too-many-instance-attributes
"""Specifies information about the availability set that the virtual machine should be assigned
to. Virtual machines specified in the same availability set are allocated to different nodes to
maximize availability. For more information about availability sets, see `Manage the
availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: Sku of the availability set, only name is required to be set. See
AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with
managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is
'Classic'.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar platform_update_domain_count: Update Domain count.
:vartype platform_update_domain_count: int
:ivar platform_fault_domain_count: Fault Domain count.
:vartype platform_fault_domain_count: int
:ivar virtual_machines: A list of references to all virtual machines in the availability set.
:vartype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the availability set should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"statuses": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
"platform_update_domain_count": {"key": "properties.platformUpdateDomainCount", "type": "int"},
"platform_fault_domain_count": {"key": "properties.platformFaultDomainCount", "type": "int"},
"virtual_machines": {"key": "properties.virtualMachines", "type": "[SubResource]"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
"statuses": {"key": "properties.statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
platform_update_domain_count: Optional[int] = None,
platform_fault_domain_count: Optional[int] = None,
virtual_machines: Optional[List["_models.SubResource"]] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: Sku of the availability set, only name is required to be set. See
AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with
managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is
'Classic'.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:keyword platform_update_domain_count: Update Domain count.
:paramtype platform_update_domain_count: int
:keyword platform_fault_domain_count: Fault Domain count.
:paramtype platform_fault_domain_count: int
:keyword virtual_machines: A list of references to all virtual machines in the availability
set.
:paramtype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the availability set should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.platform_update_domain_count = platform_update_domain_count
self.platform_fault_domain_count = platform_fault_domain_count
self.virtual_machines = virtual_machines
self.proximity_placement_group = proximity_placement_group
self.statuses = None
[docs]class AvailabilitySetListResult(_serialization.Model):
"""The List Availability Set operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of availability sets. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.AvailabilitySet]
:ivar next_link: The URI to fetch the next page of AvailabilitySets. Call ListNext() with this
URI to fetch the next page of AvailabilitySets.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[AvailabilitySet]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.AvailabilitySet"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of availability sets. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.AvailabilitySet]
:keyword next_link: The URI to fetch the next page of AvailabilitySets. Call ListNext() with
this URI to fetch the next page of AvailabilitySets.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class UpdateResource(_serialization.Model):
"""The Update Resource model definition.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.tags = tags
[docs]class AvailabilitySetUpdate(UpdateResource):
"""Specifies information about the availability set that the virtual machine should be assigned
to. Only tags may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: Sku of the availability set.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar platform_update_domain_count: Update Domain count.
:vartype platform_update_domain_count: int
:ivar platform_fault_domain_count: Fault Domain count.
:vartype platform_fault_domain_count: int
:ivar virtual_machines: A list of references to all virtual machines in the availability set.
:vartype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the availability set should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_validation = {
"statuses": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
"platform_update_domain_count": {"key": "properties.platformUpdateDomainCount", "type": "int"},
"platform_fault_domain_count": {"key": "properties.platformFaultDomainCount", "type": "int"},
"virtual_machines": {"key": "properties.virtualMachines", "type": "[SubResource]"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
"statuses": {"key": "properties.statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
platform_update_domain_count: Optional[int] = None,
platform_fault_domain_count: Optional[int] = None,
virtual_machines: Optional[List["_models.SubResource"]] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: Sku of the availability set.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:keyword platform_update_domain_count: Update Domain count.
:paramtype platform_update_domain_count: int
:keyword platform_fault_domain_count: Fault Domain count.
:paramtype platform_fault_domain_count: int
:keyword virtual_machines: A list of references to all virtual machines in the availability
set.
:paramtype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the availability set should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(tags=tags, **kwargs)
self.sku = sku
self.platform_update_domain_count = platform_update_domain_count
self.platform_fault_domain_count = platform_fault_domain_count
self.virtual_machines = virtual_machines
self.proximity_placement_group = proximity_placement_group
self.statuses = None
[docs]class BillingProfile(_serialization.Model):
"""Specifies the billing related details of a Azure Spot VM or VMSS.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:ivar max_price: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS.
This price is in US Dollars. :code:`<br>`:code:`<br>` This price will be compared with the
current Azure Spot price for the VM size. Also, the prices are compared at the time of
create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is
greater than the current Azure Spot price. :code:`<br>`:code:`<br>` The maxPrice will also be
used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice
after creation of VM/VMSS. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` - Any decimal value greater than zero. Example: 0.01538
:code:`<br>`:code:`<br>` -1 – indicates default price to be up-to on-demand.
:code:`<br>`:code:`<br>` You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS
should not be evicted for price reasons. Also, the default max price is -1 if it is not
provided by you. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:vartype max_price: float
"""
_attribute_map = {
"max_price": {"key": "maxPrice", "type": "float"},
}
def __init__(self, *, max_price: Optional[float] = None, **kwargs: Any) -> None:
"""
:keyword max_price: Specifies the maximum price you are willing to pay for a Azure Spot
VM/VMSS. This price is in US Dollars. :code:`<br>`:code:`<br>` This price will be compared with
the current Azure Spot price for the VM size. Also, the prices are compared at the time of
create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is
greater than the current Azure Spot price. :code:`<br>`:code:`<br>` The maxPrice will also be
used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice
after creation of VM/VMSS. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` - Any decimal value greater than zero. Example: 0.01538
:code:`<br>`:code:`<br>` -1 – indicates default price to be up-to on-demand.
:code:`<br>`:code:`<br>` You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS
should not be evicted for price reasons. Also, the default max price is -1 if it is not
provided by you. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:paramtype max_price: float
"""
super().__init__(**kwargs)
self.max_price = max_price
[docs]class BootDiagnostics(_serialization.Model):
"""Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot
to diagnose VM status. :code:`<br>`:code:`<br>` You can easily view the output of your console
log. :code:`<br>`:code:`<br>` Azure also enables you to see a screenshot of the VM from the
hypervisor.
:ivar enabled: Whether boot diagnostics should be enabled on the Virtual Machine.
:vartype enabled: bool
:ivar storage_uri: Uri of the storage account to use for placing the console output and
screenshot.
:vartype storage_uri: str
"""
_attribute_map = {
"enabled": {"key": "enabled", "type": "bool"},
"storage_uri": {"key": "storageUri", "type": "str"},
}
def __init__(self, *, enabled: Optional[bool] = None, storage_uri: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword enabled: Whether boot diagnostics should be enabled on the Virtual Machine.
:paramtype enabled: bool
:keyword storage_uri: Uri of the storage account to use for placing the console output and
screenshot.
:paramtype storage_uri: str
"""
super().__init__(**kwargs)
self.enabled = enabled
self.storage_uri = storage_uri
[docs]class BootDiagnosticsInstanceView(_serialization.Model):
"""The instance view of a virtual machine boot diagnostics.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar console_screenshot_blob_uri: The console screenshot blob URI.
:vartype console_screenshot_blob_uri: str
:ivar serial_console_log_blob_uri: The Linux serial console log blob Uri.
:vartype serial_console_log_blob_uri: str
:ivar status: The boot diagnostics status information for the VM. :code:`<br>`:code:`<br>`
NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.
:vartype status: ~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus
"""
_validation = {
"console_screenshot_blob_uri": {"readonly": True},
"serial_console_log_blob_uri": {"readonly": True},
"status": {"readonly": True},
}
_attribute_map = {
"console_screenshot_blob_uri": {"key": "consoleScreenshotBlobUri", "type": "str"},
"serial_console_log_blob_uri": {"key": "serialConsoleLogBlobUri", "type": "str"},
"status": {"key": "status", "type": "InstanceViewStatus"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.console_screenshot_blob_uri = None
self.serial_console_log_blob_uri = None
self.status = None
[docs]class ComputeOperationListResult(_serialization.Model):
"""The List Compute Operation operation response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The list of compute operations.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.ComputeOperationValue]
"""
_validation = {
"value": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[ComputeOperationValue]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
[docs]class ComputeOperationValue(_serialization.Model):
"""Describes the properties of a Compute Operation value.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar origin: The origin of the compute operation.
:vartype origin: str
:ivar name: The name of the compute operation.
:vartype name: str
:ivar operation: The display name of the compute operation.
:vartype operation: str
:ivar resource: The display name of the resource the operation applies to.
:vartype resource: str
:ivar description: The description of the operation.
:vartype description: str
:ivar provider: The resource provider for the operation.
:vartype provider: str
"""
_validation = {
"origin": {"readonly": True},
"name": {"readonly": True},
"operation": {"readonly": True},
"resource": {"readonly": True},
"description": {"readonly": True},
"provider": {"readonly": True},
}
_attribute_map = {
"origin": {"key": "origin", "type": "str"},
"name": {"key": "name", "type": "str"},
"operation": {"key": "display.operation", "type": "str"},
"resource": {"key": "display.resource", "type": "str"},
"description": {"key": "display.description", "type": "str"},
"provider": {"key": "display.provider", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.origin = None
self.name = None
self.operation = None
self.resource = None
self.description = None
self.provider = None
[docs]class CreationData(_serialization.Model):
"""Data used when creating a disk.
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.
:ivar create_option: This enumerates the possible sources of a disk's creation. Required. Known
values are: "Empty", "Attach", "FromImage", "Import", "Copy", "Restore", and "Upload".
:vartype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOption
:ivar storage_account_id: If createOption is Import, the Azure Resource Manager identifier of
the storage account containing the blob to import as a disk. Required only if the blob is in a
different subscription.
:vartype storage_account_id: str
:ivar image_reference: Disk source information.
:vartype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageDiskReference
:ivar source_uri: If createOption is Import, this is the URI of a blob to be imported into a
managed disk.
:vartype source_uri: str
:ivar source_resource_id: If createOption is Copy, this is the ARM id of the source snapshot or
disk.
:vartype source_resource_id: str
:ivar source_unique_id: If this field is set, this is the unique id identifying the source of
this resource.
:vartype source_unique_id: str
:ivar upload_size_bytes: If createOption is Upload, this is the size of the contents of the
upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for
the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
:vartype upload_size_bytes: int
"""
_validation = {
"create_option": {"required": True},
"source_unique_id": {"readonly": True},
}
_attribute_map = {
"create_option": {"key": "createOption", "type": "str"},
"storage_account_id": {"key": "storageAccountId", "type": "str"},
"image_reference": {"key": "imageReference", "type": "ImageDiskReference"},
"source_uri": {"key": "sourceUri", "type": "str"},
"source_resource_id": {"key": "sourceResourceId", "type": "str"},
"source_unique_id": {"key": "sourceUniqueId", "type": "str"},
"upload_size_bytes": {"key": "uploadSizeBytes", "type": "int"},
}
def __init__(
self,
*,
create_option: Union[str, "_models.DiskCreateOption"],
storage_account_id: Optional[str] = None,
image_reference: Optional["_models.ImageDiskReference"] = None,
source_uri: Optional[str] = None,
source_resource_id: Optional[str] = None,
upload_size_bytes: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword create_option: This enumerates the possible sources of a disk's creation. Required.
Known values are: "Empty", "Attach", "FromImage", "Import", "Copy", "Restore", and "Upload".
:paramtype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOption
:keyword storage_account_id: If createOption is Import, the Azure Resource Manager identifier
of the storage account containing the blob to import as a disk. Required only if the blob is in
a different subscription.
:paramtype storage_account_id: str
:keyword image_reference: Disk source information.
:paramtype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageDiskReference
:keyword source_uri: If createOption is Import, this is the URI of a blob to be imported into a
managed disk.
:paramtype source_uri: str
:keyword source_resource_id: If createOption is Copy, this is the ARM id of the source snapshot
or disk.
:paramtype source_resource_id: str
:keyword upload_size_bytes: If createOption is Upload, this is the size of the contents of the
upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for
the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
:paramtype upload_size_bytes: int
"""
super().__init__(**kwargs)
self.create_option = create_option
self.storage_account_id = storage_account_id
self.image_reference = image_reference
self.source_uri = source_uri
self.source_resource_id = source_resource_id
self.source_unique_id = None
self.upload_size_bytes = upload_size_bytes
[docs]class DataDisk(_serialization.Model):
"""Describes a data disk.
All required parameters must be populated in order to send to Azure.
:ivar lun: Specifies the logical unit number of the data disk. This value is used to identify
data disks within the VM and therefore must be unique for each data disk attached to a VM.
Required.
:vartype lun: int
:ivar name: The disk name.
:vartype name: str
:ivar vhd: The virtual hard disk.
:vartype vhd: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:vartype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:vartype write_accelerator_enabled: bool
:ivar create_option: Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Required. Known values are: "FromImage", "Empty", and
"Attach".
:vartype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:ivar disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar managed_disk: The managed disk parameters.
:vartype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.ManagedDiskParameters
:ivar to_be_detached: Specifies whether the data disk is in process of detachment from the
VirtualMachine/VirtualMachineScaleset.
:vartype to_be_detached: bool
"""
_validation = {
"lun": {"required": True},
"create_option": {"required": True},
}
_attribute_map = {
"lun": {"key": "lun", "type": "int"},
"name": {"key": "name", "type": "str"},
"vhd": {"key": "vhd", "type": "VirtualHardDisk"},
"image": {"key": "image", "type": "VirtualHardDisk"},
"caching": {"key": "caching", "type": "str"},
"write_accelerator_enabled": {"key": "writeAcceleratorEnabled", "type": "bool"},
"create_option": {"key": "createOption", "type": "str"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"managed_disk": {"key": "managedDisk", "type": "ManagedDiskParameters"},
"to_be_detached": {"key": "toBeDetached", "type": "bool"},
}
def __init__(
self,
*,
lun: int,
create_option: Union[str, "_models.DiskCreateOptionTypes"],
name: Optional[str] = None,
vhd: Optional["_models.VirtualHardDisk"] = None,
image: Optional["_models.VirtualHardDisk"] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
write_accelerator_enabled: Optional[bool] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["_models.ManagedDiskParameters"] = None,
to_be_detached: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword lun: Specifies the logical unit number of the data disk. This value is used to
identify data disks within the VM and therefore must be unique for each data disk attached to a
VM. Required.
:paramtype lun: int
:keyword name: The disk name.
:paramtype name: str
:keyword vhd: The virtual hard disk.
:paramtype vhd: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:paramtype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:paramtype write_accelerator_enabled: bool
:keyword create_option: Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Required. Known values are: "FromImage", "Empty", and
"Attach".
:paramtype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:keyword disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can
be used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword managed_disk: The managed disk parameters.
:paramtype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.ManagedDiskParameters
:keyword to_be_detached: Specifies whether the data disk is in process of detachment from the
VirtualMachine/VirtualMachineScaleset.
:paramtype to_be_detached: bool
"""
super().__init__(**kwargs)
self.lun = lun
self.name = name
self.vhd = vhd
self.image = image
self.caching = caching
self.write_accelerator_enabled = write_accelerator_enabled
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
self.to_be_detached = to_be_detached
[docs]class DataDiskImage(_serialization.Model):
"""Contains the data disk images information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar lun: Specifies the logical unit number of the data disk. This value is used to identify
data disks within the VM and therefore must be unique for each data disk attached to a VM.
:vartype lun: int
"""
_validation = {
"lun": {"readonly": True},
}
_attribute_map = {
"lun": {"key": "lun", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.lun = None
[docs]class DedicatedHost(Resource): # pylint: disable=too-many-instance-attributes
"""Specifies information about the Dedicated host.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: SKU of the dedicated host for Hardware Generation and VM family. Only name is
required to be set. List Microsoft.Compute SKUs for a list of possible values. Required.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar platform_fault_domain: Fault domain of the dedicated host within a dedicated host group.
:vartype platform_fault_domain: int
:ivar auto_replace_on_failure: Specifies whether the dedicated host should be replaced
automatically in case of a failure. The value is defaulted to 'true' when not provided.
:vartype auto_replace_on_failure: bool
:ivar host_id: A unique id generated and assigned to the dedicated host by the platform.
:code:`<br>`:code:`<br>` Does not change throughout the lifetime of the host.
:vartype host_id: str
:ivar virtual_machines: A list of references to all virtual machines in the Dedicated Host.
:vartype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResourceReadOnly]
:ivar license_type: Specifies the software license type that will be applied to the VMs
deployed on the dedicated host. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **Windows_Server_Hybrid**
:code:`<br>`:code:`<br>` **Windows_Server_Perpetual** :code:`<br>`:code:`<br>` Default:
**None**. Known values are: "None", "Windows_Server_Hybrid", and "Windows_Server_Perpetual".
:vartype license_type: str or ~azure.mgmt.compute.v2019_03_01.models.DedicatedHostLicenseTypes
:ivar provisioning_time: The date when the host was first provisioned.
:vartype provisioning_time: ~datetime.datetime
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The dedicated host instance view.
:vartype instance_view: ~azure.mgmt.compute.v2019_03_01.models.DedicatedHostInstanceView
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"sku": {"required": True},
"platform_fault_domain": {"maximum": 2, "minimum": 0},
"host_id": {"readonly": True},
"virtual_machines": {"readonly": True},
"provisioning_time": {"readonly": True},
"provisioning_state": {"readonly": True},
"instance_view": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
"platform_fault_domain": {"key": "properties.platformFaultDomain", "type": "int"},
"auto_replace_on_failure": {"key": "properties.autoReplaceOnFailure", "type": "bool"},
"host_id": {"key": "properties.hostId", "type": "str"},
"virtual_machines": {"key": "properties.virtualMachines", "type": "[SubResourceReadOnly]"},
"license_type": {"key": "properties.licenseType", "type": "str"},
"provisioning_time": {"key": "properties.provisioningTime", "type": "iso-8601"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "DedicatedHostInstanceView"},
}
def __init__(
self,
*,
location: str,
sku: "_models.Sku",
tags: Optional[Dict[str, str]] = None,
platform_fault_domain: Optional[int] = None,
auto_replace_on_failure: Optional[bool] = None,
license_type: Optional[Union[str, "_models.DedicatedHostLicenseTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: SKU of the dedicated host for Hardware Generation and VM family. Only name is
required to be set. List Microsoft.Compute SKUs for a list of possible values. Required.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:keyword platform_fault_domain: Fault domain of the dedicated host within a dedicated host
group.
:paramtype platform_fault_domain: int
:keyword auto_replace_on_failure: Specifies whether the dedicated host should be replaced
automatically in case of a failure. The value is defaulted to 'true' when not provided.
:paramtype auto_replace_on_failure: bool
:keyword license_type: Specifies the software license type that will be applied to the VMs
deployed on the dedicated host. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **Windows_Server_Hybrid**
:code:`<br>`:code:`<br>` **Windows_Server_Perpetual** :code:`<br>`:code:`<br>` Default:
**None**. Known values are: "None", "Windows_Server_Hybrid", and "Windows_Server_Perpetual".
:paramtype license_type: str or
~azure.mgmt.compute.v2019_03_01.models.DedicatedHostLicenseTypes
"""
super().__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.platform_fault_domain = platform_fault_domain
self.auto_replace_on_failure = auto_replace_on_failure
self.host_id = None
self.virtual_machines = None
self.license_type = license_type
self.provisioning_time = None
self.provisioning_state = None
self.instance_view = None
[docs]class DedicatedHostAllocatableVM(_serialization.Model):
"""Represents the dedicated host unutilized capacity in terms of a specific VM size.
:ivar vm_size: VM size in terms of which the unutilized capacity is represented.
:vartype vm_size: str
:ivar count: Maximum number of VMs of size vmSize that can fit in the dedicated host's
remaining capacity.
:vartype count: float
"""
_attribute_map = {
"vm_size": {"key": "vmSize", "type": "str"},
"count": {"key": "count", "type": "float"},
}
def __init__(self, *, vm_size: Optional[str] = None, count: Optional[float] = None, **kwargs: Any) -> None:
"""
:keyword vm_size: VM size in terms of which the unutilized capacity is represented.
:paramtype vm_size: str
:keyword count: Maximum number of VMs of size vmSize that can fit in the dedicated host's
remaining capacity.
:paramtype count: float
"""
super().__init__(**kwargs)
self.vm_size = vm_size
self.count = count
[docs]class DedicatedHostAvailableCapacity(_serialization.Model):
"""Dedicated host unutilized capacity.
:ivar allocatable_v_ms: The unutilized capacity of the dedicated host represented in terms of
each VM size that is allowed to be deployed to the dedicated host.
:vartype allocatable_v_ms:
list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostAllocatableVM]
"""
_attribute_map = {
"allocatable_v_ms": {"key": "allocatableVMs", "type": "[DedicatedHostAllocatableVM]"},
}
def __init__(
self, *, allocatable_v_ms: Optional[List["_models.DedicatedHostAllocatableVM"]] = None, **kwargs: Any
) -> None:
"""
:keyword allocatable_v_ms: The unutilized capacity of the dedicated host represented in terms
of each VM size that is allowed to be deployed to the dedicated host.
:paramtype allocatable_v_ms:
list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostAllocatableVM]
"""
super().__init__(**kwargs)
self.allocatable_v_ms = allocatable_v_ms
[docs]class DedicatedHostGroup(Resource):
"""Specifies information about the dedicated host group that the dedicated hosts should be
assigned to. :code:`<br>`:code:`<br>` Currently, a dedicated host can only be added to a
dedicated host group at creation time. An existing dedicated host cannot be added to another
dedicated host group.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar zones: Availability Zone to use for this host group. Only single zone is supported. The
zone can be assigned only during creation. If not provided, the group supports all zones in the
region. If provided, enforces each host in the group to be in the same zone.
:vartype zones: list[str]
:ivar platform_fault_domain_count: Number of fault domains that the host group can span.
:vartype platform_fault_domain_count: int
:ivar hosts: A list of references to all dedicated hosts in the dedicated host group.
:vartype hosts: list[~azure.mgmt.compute.v2019_03_01.models.SubResourceReadOnly]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"platform_fault_domain_count": {"maximum": 3, "minimum": 1},
"hosts": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"zones": {"key": "zones", "type": "[str]"},
"platform_fault_domain_count": {"key": "properties.platformFaultDomainCount", "type": "int"},
"hosts": {"key": "properties.hosts", "type": "[SubResourceReadOnly]"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
zones: Optional[List[str]] = None,
platform_fault_domain_count: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword zones: Availability Zone to use for this host group. Only single zone is supported.
The zone can be assigned only during creation. If not provided, the group supports all zones in
the region. If provided, enforces each host in the group to be in the same zone.
:paramtype zones: list[str]
:keyword platform_fault_domain_count: Number of fault domains that the host group can span.
:paramtype platform_fault_domain_count: int
"""
super().__init__(location=location, tags=tags, **kwargs)
self.zones = zones
self.platform_fault_domain_count = platform_fault_domain_count
self.hosts = None
[docs]class DedicatedHostGroupListResult(_serialization.Model):
"""The List Dedicated Host Group with resource group response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of dedicated host groups. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostGroup]
:ivar next_link: The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with
this URI to fetch the next page of Dedicated Host Groups.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[DedicatedHostGroup]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.DedicatedHostGroup"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of dedicated host groups. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHostGroup]
:keyword next_link: The URI to fetch the next page of Dedicated Host Groups. Call ListNext()
with this URI to fetch the next page of Dedicated Host Groups.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class DedicatedHostGroupUpdate(UpdateResource):
"""Specifies information about the dedicated host group that the dedicated host should be assigned
to. Only tags may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar zones: Availability Zone to use for this host group. Only single zone is supported. The
zone can be assigned only during creation. If not provided, the group supports all zones in the
region. If provided, enforces each host in the group to be in the same zone.
:vartype zones: list[str]
:ivar platform_fault_domain_count: Number of fault domains that the host group can span.
:vartype platform_fault_domain_count: int
:ivar hosts: A list of references to all dedicated hosts in the dedicated host group.
:vartype hosts: list[~azure.mgmt.compute.v2019_03_01.models.SubResourceReadOnly]
"""
_validation = {
"platform_fault_domain_count": {"maximum": 3, "minimum": 1},
"hosts": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"zones": {"key": "zones", "type": "[str]"},
"platform_fault_domain_count": {"key": "properties.platformFaultDomainCount", "type": "int"},
"hosts": {"key": "properties.hosts", "type": "[SubResourceReadOnly]"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
zones: Optional[List[str]] = None,
platform_fault_domain_count: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword zones: Availability Zone to use for this host group. Only single zone is supported.
The zone can be assigned only during creation. If not provided, the group supports all zones in
the region. If provided, enforces each host in the group to be in the same zone.
:paramtype zones: list[str]
:keyword platform_fault_domain_count: Number of fault domains that the host group can span.
:paramtype platform_fault_domain_count: int
"""
super().__init__(tags=tags, **kwargs)
self.zones = zones
self.platform_fault_domain_count = platform_fault_domain_count
self.hosts = None
[docs]class DedicatedHostInstanceView(_serialization.Model):
"""The instance view of a dedicated host.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar asset_id: Specifies the unique id of the dedicated physical machine on which the
dedicated host resides.
:vartype asset_id: str
:ivar available_capacity: Unutilized capacity of the dedicated host.
:vartype available_capacity:
~azure.mgmt.compute.v2019_03_01.models.DedicatedHostAvailableCapacity
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_validation = {
"asset_id": {"readonly": True},
}
_attribute_map = {
"asset_id": {"key": "assetId", "type": "str"},
"available_capacity": {"key": "availableCapacity", "type": "DedicatedHostAvailableCapacity"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
available_capacity: Optional["_models.DedicatedHostAvailableCapacity"] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
**kwargs: Any
) -> None:
"""
:keyword available_capacity: Unutilized capacity of the dedicated host.
:paramtype available_capacity:
~azure.mgmt.compute.v2019_03_01.models.DedicatedHostAvailableCapacity
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.asset_id = None
self.available_capacity = available_capacity
self.statuses = statuses
[docs]class DedicatedHostListResult(_serialization.Model):
"""The list dedicated host operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of dedicated hosts. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHost]
:ivar next_link: The URI to fetch the next page of dedicated hosts. Call ListNext() with this
URI to fetch the next page of dedicated hosts.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[DedicatedHost]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.DedicatedHost"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: The list of dedicated hosts. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.DedicatedHost]
:keyword next_link: The URI to fetch the next page of dedicated hosts. Call ListNext() with
this URI to fetch the next page of dedicated hosts.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class DedicatedHostUpdate(UpdateResource):
"""Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType
may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar platform_fault_domain: Fault domain of the dedicated host within a dedicated host group.
:vartype platform_fault_domain: int
:ivar auto_replace_on_failure: Specifies whether the dedicated host should be replaced
automatically in case of a failure. The value is defaulted to 'true' when not provided.
:vartype auto_replace_on_failure: bool
:ivar host_id: A unique id generated and assigned to the dedicated host by the platform.
:code:`<br>`:code:`<br>` Does not change throughout the lifetime of the host.
:vartype host_id: str
:ivar virtual_machines: A list of references to all virtual machines in the Dedicated Host.
:vartype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResourceReadOnly]
:ivar license_type: Specifies the software license type that will be applied to the VMs
deployed on the dedicated host. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **Windows_Server_Hybrid**
:code:`<br>`:code:`<br>` **Windows_Server_Perpetual** :code:`<br>`:code:`<br>` Default:
**None**. Known values are: "None", "Windows_Server_Hybrid", and "Windows_Server_Perpetual".
:vartype license_type: str or ~azure.mgmt.compute.v2019_03_01.models.DedicatedHostLicenseTypes
:ivar provisioning_time: The date when the host was first provisioned.
:vartype provisioning_time: ~datetime.datetime
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The dedicated host instance view.
:vartype instance_view: ~azure.mgmt.compute.v2019_03_01.models.DedicatedHostInstanceView
"""
_validation = {
"platform_fault_domain": {"maximum": 2, "minimum": 0},
"host_id": {"readonly": True},
"virtual_machines": {"readonly": True},
"provisioning_time": {"readonly": True},
"provisioning_state": {"readonly": True},
"instance_view": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"platform_fault_domain": {"key": "properties.platformFaultDomain", "type": "int"},
"auto_replace_on_failure": {"key": "properties.autoReplaceOnFailure", "type": "bool"},
"host_id": {"key": "properties.hostId", "type": "str"},
"virtual_machines": {"key": "properties.virtualMachines", "type": "[SubResourceReadOnly]"},
"license_type": {"key": "properties.licenseType", "type": "str"},
"provisioning_time": {"key": "properties.provisioningTime", "type": "iso-8601"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "DedicatedHostInstanceView"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
platform_fault_domain: Optional[int] = None,
auto_replace_on_failure: Optional[bool] = None,
license_type: Optional[Union[str, "_models.DedicatedHostLicenseTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword platform_fault_domain: Fault domain of the dedicated host within a dedicated host
group.
:paramtype platform_fault_domain: int
:keyword auto_replace_on_failure: Specifies whether the dedicated host should be replaced
automatically in case of a failure. The value is defaulted to 'true' when not provided.
:paramtype auto_replace_on_failure: bool
:keyword license_type: Specifies the software license type that will be applied to the VMs
deployed on the dedicated host. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **Windows_Server_Hybrid**
:code:`<br>`:code:`<br>` **Windows_Server_Perpetual** :code:`<br>`:code:`<br>` Default:
**None**. Known values are: "None", "Windows_Server_Hybrid", and "Windows_Server_Perpetual".
:paramtype license_type: str or
~azure.mgmt.compute.v2019_03_01.models.DedicatedHostLicenseTypes
"""
super().__init__(tags=tags, **kwargs)
self.platform_fault_domain = platform_fault_domain
self.auto_replace_on_failure = auto_replace_on_failure
self.host_id = None
self.virtual_machines = None
self.license_type = license_type
self.provisioning_time = None
self.provisioning_state = None
self.instance_view = None
[docs]class DiagnosticsProfile(_serialization.Model):
"""Specifies the boot diagnostic settings state. :code:`<br>`:code:`<br>`Minimum api-version:
2015-06-15.
:ivar boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:vartype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnostics
"""
_attribute_map = {
"boot_diagnostics": {"key": "bootDiagnostics", "type": "BootDiagnostics"},
}
def __init__(self, *, boot_diagnostics: Optional["_models.BootDiagnostics"] = None, **kwargs: Any) -> None:
"""
:keyword boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:paramtype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnostics
"""
super().__init__(**kwargs)
self.boot_diagnostics = boot_diagnostics
[docs]class DiffDiskSettings(_serialization.Model):
"""Describes the parameters of ephemeral disk settings that can be specified for operating system
disk. :code:`<br>`:code:`<br>` NOTE: The ephemeral disk settings can only be specified for
managed disk.
:ivar option: Specifies the ephemeral disk settings for operating system disk. "Local"
:vartype option: str or ~azure.mgmt.compute.v2019_03_01.models.DiffDiskOptions
"""
_attribute_map = {
"option": {"key": "option", "type": "str"},
}
def __init__(self, *, option: Optional[Union[str, "_models.DiffDiskOptions"]] = None, **kwargs: Any) -> None:
"""
:keyword option: Specifies the ephemeral disk settings for operating system disk. "Local"
:paramtype option: str or ~azure.mgmt.compute.v2019_03_01.models.DiffDiskOptions
"""
super().__init__(**kwargs)
self.option = option
[docs]class Disallowed(_serialization.Model):
"""Describes the disallowed disk types.
:ivar disk_types: A list of disk types.
:vartype disk_types: list[str]
"""
_attribute_map = {
"disk_types": {"key": "diskTypes", "type": "[str]"},
}
def __init__(self, *, disk_types: Optional[List[str]] = None, **kwargs: Any) -> None:
"""
:keyword disk_types: A list of disk types.
:paramtype disk_types: list[str]
"""
super().__init__(**kwargs)
self.disk_types = disk_types
[docs]class Disk(Resource): # pylint: disable=too-many-instance-attributes
"""Disk resource.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar managed_by: A relative URI containing the ID of the VM that has the disk attached.
:vartype managed_by: str
:ivar sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or
UltraSSD_LRS.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.DiskSku
:ivar zones: The Logical zone list for Disk.
:vartype zones: list[str]
:ivar time_created: The time when the disk was created.
:vartype time_created: ~datetime.datetime
:ivar os_type: The Operating System type. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar hyper_v_generation: The hypervisor generation of the Virtual Machine. Applicable to OS
disks only. Known values are: "V1" and "V2".
:vartype hyper_v_generation: str or ~azure.mgmt.compute.v2019_03_01.models.HyperVGeneration
:ivar creation_data: Disk source information. CreationData information cannot be changed after
the disk has been created.
:vartype creation_data: ~azure.mgmt.compute.v2019_03_01.models.CreationData
:ivar disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:vartype disk_size_gb: int
:ivar disk_size_bytes: The size of the disk in bytes. This field is read only.
:vartype disk_size_bytes: int
:ivar unique_id: Unique Guid identifying the resource.
:vartype unique_id: str
:ivar encryption_settings_collection: Encryption settings collection used for Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:vartype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:ivar provisioning_state: The disk provisioning state.
:vartype provisioning_state: str
:ivar disk_iops_read_write: The number of IOPS allowed for this disk; only settable for
UltraSSD disks. One operation can transfer between 4k and 256k bytes.
:vartype disk_iops_read_write: int
:ivar disk_m_bps_read_write: The bandwidth allowed for this disk; only settable for UltraSSD
disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of
10.
:vartype disk_m_bps_read_write: int
:ivar disk_state: The state of the disk. Known values are: "Unattached", "Attached",
"Reserved", "ActiveSAS", "ReadyToUpload", and "ActiveUpload".
:vartype disk_state: str or ~azure.mgmt.compute.v2019_03_01.models.DiskState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"managed_by": {"readonly": True},
"time_created": {"readonly": True},
"disk_size_bytes": {"readonly": True},
"unique_id": {"readonly": True},
"provisioning_state": {"readonly": True},
"disk_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"managed_by": {"key": "managedBy", "type": "str"},
"sku": {"key": "sku", "type": "DiskSku"},
"zones": {"key": "zones", "type": "[str]"},
"time_created": {"key": "properties.timeCreated", "type": "iso-8601"},
"os_type": {"key": "properties.osType", "type": "str"},
"hyper_v_generation": {"key": "properties.hyperVGeneration", "type": "str"},
"creation_data": {"key": "properties.creationData", "type": "CreationData"},
"disk_size_gb": {"key": "properties.diskSizeGB", "type": "int"},
"disk_size_bytes": {"key": "properties.diskSizeBytes", "type": "int"},
"unique_id": {"key": "properties.uniqueId", "type": "str"},
"encryption_settings_collection": {
"key": "properties.encryptionSettingsCollection",
"type": "EncryptionSettingsCollection",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"disk_iops_read_write": {"key": "properties.diskIOPSReadWrite", "type": "int"},
"disk_m_bps_read_write": {"key": "properties.diskMBpsReadWrite", "type": "int"},
"disk_state": {"key": "properties.diskState", "type": "str"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.DiskSku"] = None,
zones: Optional[List[str]] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGeneration"]] = None,
creation_data: Optional["_models.CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings_collection: Optional["_models.EncryptionSettingsCollection"] = None,
disk_iops_read_write: Optional[int] = None,
disk_m_bps_read_write: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or
UltraSSD_LRS.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.DiskSku
:keyword zones: The Logical zone list for Disk.
:paramtype zones: list[str]
:keyword os_type: The Operating System type. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword hyper_v_generation: The hypervisor generation of the Virtual Machine. Applicable to OS
disks only. Known values are: "V1" and "V2".
:paramtype hyper_v_generation: str or ~azure.mgmt.compute.v2019_03_01.models.HyperVGeneration
:keyword creation_data: Disk source information. CreationData information cannot be changed
after the disk has been created.
:paramtype creation_data: ~azure.mgmt.compute.v2019_03_01.models.CreationData
:keyword disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:paramtype disk_size_gb: int
:keyword encryption_settings_collection: Encryption settings collection used for Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:paramtype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:keyword disk_iops_read_write: The number of IOPS allowed for this disk; only settable for
UltraSSD disks. One operation can transfer between 4k and 256k bytes.
:paramtype disk_iops_read_write: int
:keyword disk_m_bps_read_write: The bandwidth allowed for this disk; only settable for UltraSSD
disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of
10.
:paramtype disk_m_bps_read_write: int
"""
super().__init__(location=location, tags=tags, **kwargs)
self.managed_by = None
self.sku = sku
self.zones = zones
self.time_created = None
self.os_type = os_type
self.hyper_v_generation = hyper_v_generation
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.disk_size_bytes = None
self.unique_id = None
self.encryption_settings_collection = encryption_settings_collection
self.provisioning_state = None
self.disk_iops_read_write = disk_iops_read_write
self.disk_m_bps_read_write = disk_m_bps_read_write
self.disk_state = None
[docs]class DiskEncryptionSettings(_serialization.Model):
"""Describes a Encryption Settings for a Disk.
:ivar disk_encryption_key: Specifies the location of the disk encryption key, which is a Key
Vault Secret.
:vartype disk_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultSecretReference
:ivar key_encryption_key: Specifies the location of the key encryption key in Key Vault.
:vartype key_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultKeyReference
:ivar enabled: Specifies whether disk encryption should be enabled on the virtual machine.
:vartype enabled: bool
"""
_attribute_map = {
"disk_encryption_key": {"key": "diskEncryptionKey", "type": "KeyVaultSecretReference"},
"key_encryption_key": {"key": "keyEncryptionKey", "type": "KeyVaultKeyReference"},
"enabled": {"key": "enabled", "type": "bool"},
}
def __init__(
self,
*,
disk_encryption_key: Optional["_models.KeyVaultSecretReference"] = None,
key_encryption_key: Optional["_models.KeyVaultKeyReference"] = None,
enabled: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword disk_encryption_key: Specifies the location of the disk encryption key, which is a Key
Vault Secret.
:paramtype disk_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultSecretReference
:keyword key_encryption_key: Specifies the location of the key encryption key in Key Vault.
:paramtype key_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultKeyReference
:keyword enabled: Specifies whether disk encryption should be enabled on the virtual machine.
:paramtype enabled: bool
"""
super().__init__(**kwargs)
self.disk_encryption_key = disk_encryption_key
self.key_encryption_key = key_encryption_key
self.enabled = enabled
[docs]class DiskInstanceView(_serialization.Model):
"""The instance view of the disk.
:ivar name: The disk name.
:vartype name: str
:ivar encryption_settings: Specifies the encryption settings for the OS Disk.
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype encryption_settings:
list[~azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings]
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"encryption_settings": {"key": "encryptionSettings", "type": "[DiskEncryptionSettings]"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
encryption_settings: Optional[List["_models.DiskEncryptionSettings"]] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The disk name.
:paramtype name: str
:keyword encryption_settings: Specifies the encryption settings for the OS Disk.
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype encryption_settings:
list[~azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings]
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.name = name
self.encryption_settings = encryption_settings
self.statuses = statuses
[docs]class DiskList(_serialization.Model):
"""The List Disks operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of disks. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.Disk]
:ivar next_link: The uri to fetch the next page of disks. Call ListNext() with this to fetch
the next page of disks.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Disk]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.Disk"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: A list of disks. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.Disk]
:keyword next_link: The uri to fetch the next page of disks. Call ListNext() with this to fetch
the next page of disks.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class DiskSku(_serialization.Model):
"""The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: The sku name. Known values are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS",
and "UltraSSD_LRS".
:vartype name: str or ~azure.mgmt.compute.v2019_03_01.models.DiskStorageAccountTypes
:ivar tier: The sku tier.
:vartype tier: str
"""
_validation = {
"tier": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"tier": {"key": "tier", "type": "str"},
}
def __init__(self, *, name: Optional[Union[str, "_models.DiskStorageAccountTypes"]] = None, **kwargs: Any) -> None:
"""
:keyword name: The sku name. Known values are: "Standard_LRS", "Premium_LRS",
"StandardSSD_LRS", and "UltraSSD_LRS".
:paramtype name: str or ~azure.mgmt.compute.v2019_03_01.models.DiskStorageAccountTypes
"""
super().__init__(**kwargs)
self.name = name
self.tier = None
[docs]class DiskUpdate(_serialization.Model):
"""Disk update resource.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or
UltraSSD_LRS.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.DiskSku
:ivar os_type: the Operating System type. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:vartype disk_size_gb: int
:ivar encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:vartype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:ivar disk_iops_read_write: The number of IOPS allowed for this disk; only settable for
UltraSSD disks. One operation can transfer between 4k and 256k bytes.
:vartype disk_iops_read_write: int
:ivar disk_m_bps_read_write: The bandwidth allowed for this disk; only settable for UltraSSD
disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of
10.
:vartype disk_m_bps_read_write: int
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "DiskSku"},
"os_type": {"key": "properties.osType", "type": "str"},
"disk_size_gb": {"key": "properties.diskSizeGB", "type": "int"},
"encryption_settings_collection": {
"key": "properties.encryptionSettingsCollection",
"type": "EncryptionSettingsCollection",
},
"disk_iops_read_write": {"key": "properties.diskIOPSReadWrite", "type": "int"},
"disk_m_bps_read_write": {"key": "properties.diskMBpsReadWrite", "type": "int"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.DiskSku"] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
disk_size_gb: Optional[int] = None,
encryption_settings_collection: Optional["_models.EncryptionSettingsCollection"] = None,
disk_iops_read_write: Optional[int] = None,
disk_m_bps_read_write: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or
UltraSSD_LRS.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.DiskSku
:keyword os_type: the Operating System type. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:paramtype disk_size_gb: int
:keyword encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:paramtype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:keyword disk_iops_read_write: The number of IOPS allowed for this disk; only settable for
UltraSSD disks. One operation can transfer between 4k and 256k bytes.
:paramtype disk_iops_read_write: int
:keyword disk_m_bps_read_write: The bandwidth allowed for this disk; only settable for UltraSSD
disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of
10.
:paramtype disk_m_bps_read_write: int
"""
super().__init__(**kwargs)
self.tags = tags
self.sku = sku
self.os_type = os_type
self.disk_size_gb = disk_size_gb
self.encryption_settings_collection = encryption_settings_collection
self.disk_iops_read_write = disk_iops_read_write
self.disk_m_bps_read_write = disk_m_bps_read_write
[docs]class EncryptionSettingsCollection(_serialization.Model):
"""Encryption settings for disk or snapshot.
All required parameters must be populated in order to send to Azure.
:ivar enabled: Set this flag to true and provide DiskEncryptionKey and optional
KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and
KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object,
the existing settings remain unchanged. Required.
:vartype enabled: bool
:ivar encryption_settings: A collection of encryption settings, one for each disk volume.
:vartype encryption_settings:
list[~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsElement]
:ivar encryption_settings_version: Describes what type of encryption is used for the disks.
Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption
with AAD app.'1.1' corresponds to Azure Disk Encryption.
:vartype encryption_settings_version: str
"""
_validation = {
"enabled": {"required": True},
}
_attribute_map = {
"enabled": {"key": "enabled", "type": "bool"},
"encryption_settings": {"key": "encryptionSettings", "type": "[EncryptionSettingsElement]"},
"encryption_settings_version": {"key": "encryptionSettingsVersion", "type": "str"},
}
def __init__(
self,
*,
enabled: bool,
encryption_settings: Optional[List["_models.EncryptionSettingsElement"]] = None,
encryption_settings_version: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword enabled: Set this flag to true and provide DiskEncryptionKey and optional
KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and
KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object,
the existing settings remain unchanged. Required.
:paramtype enabled: bool
:keyword encryption_settings: A collection of encryption settings, one for each disk volume.
:paramtype encryption_settings:
list[~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsElement]
:keyword encryption_settings_version: Describes what type of encryption is used for the disks.
Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption
with AAD app.'1.1' corresponds to Azure Disk Encryption.
:paramtype encryption_settings_version: str
"""
super().__init__(**kwargs)
self.enabled = enabled
self.encryption_settings = encryption_settings
self.encryption_settings_version = encryption_settings_version
[docs]class EncryptionSettingsElement(_serialization.Model):
"""Encryption settings for one disk volume.
:ivar disk_encryption_key: Key Vault Secret Url and vault id of the disk encryption key.
:vartype disk_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultAndSecretReference
:ivar key_encryption_key: Key Vault Key Url and vault id of the key encryption key.
KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.
:vartype key_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultAndKeyReference
"""
_attribute_map = {
"disk_encryption_key": {"key": "diskEncryptionKey", "type": "KeyVaultAndSecretReference"},
"key_encryption_key": {"key": "keyEncryptionKey", "type": "KeyVaultAndKeyReference"},
}
def __init__(
self,
*,
disk_encryption_key: Optional["_models.KeyVaultAndSecretReference"] = None,
key_encryption_key: Optional["_models.KeyVaultAndKeyReference"] = None,
**kwargs: Any
) -> None:
"""
:keyword disk_encryption_key: Key Vault Secret Url and vault id of the disk encryption key.
:paramtype disk_encryption_key:
~azure.mgmt.compute.v2019_03_01.models.KeyVaultAndSecretReference
:keyword key_encryption_key: Key Vault Key Url and vault id of the key encryption key.
KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.
:paramtype key_encryption_key: ~azure.mgmt.compute.v2019_03_01.models.KeyVaultAndKeyReference
"""
super().__init__(**kwargs)
self.disk_encryption_key = disk_encryption_key
self.key_encryption_key = key_encryption_key
[docs]class Gallery(Resource):
"""Specifies information about the Shared Image Gallery that you want to create or update.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar description: The description of this Shared Image Gallery resource. This property is
updatable.
:vartype description: str
:ivar identifier: Describes the gallery unique name.
:vartype identifier: ~azure.mgmt.compute.v2019_03_01.models.GalleryIdentifier
:ivar provisioning_state: The provisioning state, which only appears in the response. Known
values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
:vartype provisioning_state: str or
~azure.mgmt.compute.v2019_03_01.models.GalleryPropertiesProvisioningState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"description": {"key": "properties.description", "type": "str"},
"identifier": {"key": "properties.identifier", "type": "GalleryIdentifier"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
description: Optional[str] = None,
identifier: Optional["_models.GalleryIdentifier"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword description: The description of this Shared Image Gallery resource. This property is
updatable.
:paramtype description: str
:keyword identifier: Describes the gallery unique name.
:paramtype identifier: ~azure.mgmt.compute.v2019_03_01.models.GalleryIdentifier
"""
super().__init__(location=location, tags=tags, **kwargs)
self.description = description
self.identifier = identifier
self.provisioning_state = None
[docs]class GalleryApplication(Resource): # pylint: disable=too-many-instance-attributes
"""Specifies information about the gallery Application Definition that you want to create or
update.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar description: The description of this gallery Application Definition resource. This
property is updatable.
:vartype description: str
:ivar eula: The Eula agreement for the gallery Application Definition.
:vartype eula: str
:ivar privacy_statement_uri: The privacy statement uri.
:vartype privacy_statement_uri: str
:ivar release_note_uri: The release note uri.
:vartype release_note_uri: str
:ivar end_of_life_date: The end of life date of the gallery Application Definition. This
property can be used for decommissioning purposes. This property is updatable.
:vartype end_of_life_date: ~datetime.datetime
:ivar supported_os_type: This property allows you to specify the supported type of the OS that
application is built for. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known values are:
"Windows" and "Linux".
:vartype supported_os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"description": {"key": "properties.description", "type": "str"},
"eula": {"key": "properties.eula", "type": "str"},
"privacy_statement_uri": {"key": "properties.privacyStatementUri", "type": "str"},
"release_note_uri": {"key": "properties.releaseNoteUri", "type": "str"},
"end_of_life_date": {"key": "properties.endOfLifeDate", "type": "iso-8601"},
"supported_os_type": {"key": "properties.supportedOSType", "type": "str"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
description: Optional[str] = None,
eula: Optional[str] = None,
privacy_statement_uri: Optional[str] = None,
release_note_uri: Optional[str] = None,
end_of_life_date: Optional[datetime.datetime] = None,
supported_os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword description: The description of this gallery Application Definition resource. This
property is updatable.
:paramtype description: str
:keyword eula: The Eula agreement for the gallery Application Definition.
:paramtype eula: str
:keyword privacy_statement_uri: The privacy statement uri.
:paramtype privacy_statement_uri: str
:keyword release_note_uri: The release note uri.
:paramtype release_note_uri: str
:keyword end_of_life_date: The end of life date of the gallery Application Definition. This
property can be used for decommissioning purposes. This property is updatable.
:paramtype end_of_life_date: ~datetime.datetime
:keyword supported_os_type: This property allows you to specify the supported type of the OS
that application is built for. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known values are:
"Windows" and "Linux".
:paramtype supported_os_type: str or
~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
"""
super().__init__(location=location, tags=tags, **kwargs)
self.description = description
self.eula = eula
self.privacy_statement_uri = privacy_statement_uri
self.release_note_uri = release_note_uri
self.end_of_life_date = end_of_life_date
self.supported_os_type = supported_os_type
[docs]class GalleryApplicationList(_serialization.Model):
"""The List Gallery Applications operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of Gallery Applications. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryApplication]
:ivar next_link: The uri to fetch the next page of Application Definitions in the Application
Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[GalleryApplication]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.GalleryApplication"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: A list of Gallery Applications. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryApplication]
:keyword next_link: The uri to fetch the next page of Application Definitions in the
Application Gallery. Call ListNext() with this to fetch the next page of gallery Application
Definitions.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class GalleryApplicationVersion(Resource):
"""Specifies information about the gallery Application Version that you want to create or update.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar publishing_profile: The publishing profile of a gallery image version.
:vartype publishing_profile:
~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersionPublishingProfile
:ivar provisioning_state: The provisioning state, which only appears in the response. Known
values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
:vartype provisioning_state: str or
~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersionPropertiesProvisioningState
:ivar replication_status: This is the replication status of the gallery Image Version.
:vartype replication_status: ~azure.mgmt.compute.v2019_03_01.models.ReplicationStatus
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
"replication_status": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"publishing_profile": {
"key": "properties.publishingProfile",
"type": "GalleryApplicationVersionPublishingProfile",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"replication_status": {"key": "properties.replicationStatus", "type": "ReplicationStatus"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
publishing_profile: Optional["_models.GalleryApplicationVersionPublishingProfile"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword publishing_profile: The publishing profile of a gallery image version.
:paramtype publishing_profile:
~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersionPublishingProfile
"""
super().__init__(location=location, tags=tags, **kwargs)
self.publishing_profile = publishing_profile
self.provisioning_state = None
self.replication_status = None
[docs]class GalleryApplicationVersionList(_serialization.Model):
"""The List Gallery Application version operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of gallery Application Versions. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersion]
:ivar next_link: The uri to fetch the next page of gallery Application Versions. Call
ListNext() with this to fetch the next page of gallery Application Versions.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[GalleryApplicationVersion]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.GalleryApplicationVersion"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: A list of gallery Application Versions. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryApplicationVersion]
:keyword next_link: The uri to fetch the next page of gallery Application Versions. Call
ListNext() with this to fetch the next page of gallery Application Versions.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class GalleryArtifactPublishingProfileBase(_serialization.Model):
"""Describes the basic gallery artifact publishing profile.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar target_regions: The target regions where the Image Version is going to be replicated to.
This property is updatable.
:vartype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:ivar replica_count: The number of replicas of the Image Version to be created per region. This
property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:vartype replica_count: int
:ivar exclude_from_latest: If set to true, Virtual Machines deployed from the latest version of
the Image Definition won't use this Image Version.
:vartype exclude_from_latest: bool
:ivar published_date: The timestamp for when the gallery Image Version is published.
:vartype published_date: ~datetime.datetime
:ivar end_of_life_date: The end of life date of the gallery Image Version. This property can be
used for decommissioning purposes. This property is updatable.
:vartype end_of_life_date: ~datetime.datetime
:ivar storage_account_type: Specifies the storage account type to be used to store the image.
This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:vartype storage_account_type: str or ~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
"""
_validation = {
"published_date": {"readonly": True},
}
_attribute_map = {
"target_regions": {"key": "targetRegions", "type": "[TargetRegion]"},
"replica_count": {"key": "replicaCount", "type": "int"},
"exclude_from_latest": {"key": "excludeFromLatest", "type": "bool"},
"published_date": {"key": "publishedDate", "type": "iso-8601"},
"end_of_life_date": {"key": "endOfLifeDate", "type": "iso-8601"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
target_regions: Optional[List["_models.TargetRegion"]] = None,
replica_count: Optional[int] = None,
exclude_from_latest: Optional[bool] = None,
end_of_life_date: Optional[datetime.datetime] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountType"]] = None,
**kwargs: Any
) -> None:
"""
:keyword target_regions: The target regions where the Image Version is going to be replicated
to. This property is updatable.
:paramtype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:keyword replica_count: The number of replicas of the Image Version to be created per region.
This property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:paramtype replica_count: int
:keyword exclude_from_latest: If set to true, Virtual Machines deployed from the latest version
of the Image Definition won't use this Image Version.
:paramtype exclude_from_latest: bool
:keyword end_of_life_date: The end of life date of the gallery Image Version. This property can
be used for decommissioning purposes. This property is updatable.
:paramtype end_of_life_date: ~datetime.datetime
:keyword storage_account_type: Specifies the storage account type to be used to store the
image. This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
"""
super().__init__(**kwargs)
self.target_regions = target_regions
self.replica_count = replica_count
self.exclude_from_latest = exclude_from_latest
self.published_date = None
self.end_of_life_date = end_of_life_date
self.storage_account_type = storage_account_type
[docs]class GalleryApplicationVersionPublishingProfile(GalleryArtifactPublishingProfileBase):
"""The publishing profile of a gallery image version.
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.
:ivar target_regions: The target regions where the Image Version is going to be replicated to.
This property is updatable.
:vartype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:ivar replica_count: The number of replicas of the Image Version to be created per region. This
property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:vartype replica_count: int
:ivar exclude_from_latest: If set to true, Virtual Machines deployed from the latest version of
the Image Definition won't use this Image Version.
:vartype exclude_from_latest: bool
:ivar published_date: The timestamp for when the gallery Image Version is published.
:vartype published_date: ~datetime.datetime
:ivar end_of_life_date: The end of life date of the gallery Image Version. This property can be
used for decommissioning purposes. This property is updatable.
:vartype end_of_life_date: ~datetime.datetime
:ivar storage_account_type: Specifies the storage account type to be used to store the image.
This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:vartype storage_account_type: str or ~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
:ivar source: The source image from which the Image Version is going to be created. Required.
:vartype source: ~azure.mgmt.compute.v2019_03_01.models.UserArtifactSource
:ivar manage_actions:
:vartype manage_actions: ~azure.mgmt.compute.v2019_03_01.models.UserArtifactManage
:ivar enable_health_check: Optional. Whether or not this application reports health.
:vartype enable_health_check: bool
"""
_validation = {
"published_date": {"readonly": True},
"source": {"required": True},
}
_attribute_map = {
"target_regions": {"key": "targetRegions", "type": "[TargetRegion]"},
"replica_count": {"key": "replicaCount", "type": "int"},
"exclude_from_latest": {"key": "excludeFromLatest", "type": "bool"},
"published_date": {"key": "publishedDate", "type": "iso-8601"},
"end_of_life_date": {"key": "endOfLifeDate", "type": "iso-8601"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
"source": {"key": "source", "type": "UserArtifactSource"},
"manage_actions": {"key": "manageActions", "type": "UserArtifactManage"},
"enable_health_check": {"key": "enableHealthCheck", "type": "bool"},
}
def __init__(
self,
*,
source: "_models.UserArtifactSource",
target_regions: Optional[List["_models.TargetRegion"]] = None,
replica_count: Optional[int] = None,
exclude_from_latest: Optional[bool] = None,
end_of_life_date: Optional[datetime.datetime] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountType"]] = None,
manage_actions: Optional["_models.UserArtifactManage"] = None,
enable_health_check: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword target_regions: The target regions where the Image Version is going to be replicated
to. This property is updatable.
:paramtype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:keyword replica_count: The number of replicas of the Image Version to be created per region.
This property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:paramtype replica_count: int
:keyword exclude_from_latest: If set to true, Virtual Machines deployed from the latest version
of the Image Definition won't use this Image Version.
:paramtype exclude_from_latest: bool
:keyword end_of_life_date: The end of life date of the gallery Image Version. This property can
be used for decommissioning purposes. This property is updatable.
:paramtype end_of_life_date: ~datetime.datetime
:keyword storage_account_type: Specifies the storage account type to be used to store the
image. This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
:keyword source: The source image from which the Image Version is going to be created.
Required.
:paramtype source: ~azure.mgmt.compute.v2019_03_01.models.UserArtifactSource
:keyword manage_actions:
:paramtype manage_actions: ~azure.mgmt.compute.v2019_03_01.models.UserArtifactManage
:keyword enable_health_check: Optional. Whether or not this application reports health.
:paramtype enable_health_check: bool
"""
super().__init__(
target_regions=target_regions,
replica_count=replica_count,
exclude_from_latest=exclude_from_latest,
end_of_life_date=end_of_life_date,
storage_account_type=storage_account_type,
**kwargs
)
self.source = source
self.manage_actions = manage_actions
self.enable_health_check = enable_health_check
[docs]class GalleryArtifactSource(_serialization.Model):
"""The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
:ivar managed_image: The managed artifact. Required.
:vartype managed_image: ~azure.mgmt.compute.v2019_03_01.models.ManagedArtifact
"""
_validation = {
"managed_image": {"required": True},
}
_attribute_map = {
"managed_image": {"key": "managedImage", "type": "ManagedArtifact"},
}
def __init__(self, *, managed_image: "_models.ManagedArtifact", **kwargs: Any) -> None:
"""
:keyword managed_image: The managed artifact. Required.
:paramtype managed_image: ~azure.mgmt.compute.v2019_03_01.models.ManagedArtifact
"""
super().__init__(**kwargs)
self.managed_image = managed_image
[docs]class GalleryDiskImage(_serialization.Model):
"""This is the disk image base class.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar size_in_gb: This property indicates the size of the VHD to be created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None', 'ReadOnly', and
'ReadWrite'. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype host_caching: str or ~azure.mgmt.compute.v2019_03_01.models.HostCaching
"""
_validation = {
"size_in_gb": {"readonly": True},
"host_caching": {"readonly": True},
}
_attribute_map = {
"size_in_gb": {"key": "sizeInGB", "type": "int"},
"host_caching": {"key": "hostCaching", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.size_in_gb = None
self.host_caching = None
[docs]class GalleryDataDiskImage(GalleryDiskImage):
"""This is the data disk image.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar size_in_gb: This property indicates the size of the VHD to be created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None', 'ReadOnly', and
'ReadWrite'. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype host_caching: str or ~azure.mgmt.compute.v2019_03_01.models.HostCaching
:ivar lun: This property specifies the logical unit number of the data disk. This value is used
to identify data disks within the Virtual Machine and therefore must be unique for each data
disk attached to the Virtual Machine.
:vartype lun: int
"""
_validation = {
"size_in_gb": {"readonly": True},
"host_caching": {"readonly": True},
"lun": {"readonly": True},
}
_attribute_map = {
"size_in_gb": {"key": "sizeInGB", "type": "int"},
"host_caching": {"key": "hostCaching", "type": "str"},
"lun": {"key": "lun", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.lun = None
[docs]class GalleryIdentifier(_serialization.Model):
"""Describes the gallery unique name.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar unique_name: The unique name of the Shared Image Gallery. This name is generated
automatically by Azure.
:vartype unique_name: str
"""
_validation = {
"unique_name": {"readonly": True},
}
_attribute_map = {
"unique_name": {"key": "uniqueName", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.unique_name = None
[docs]class GalleryImage(Resource): # pylint: disable=too-many-instance-attributes
"""Specifies information about the gallery Image Definition that you want to create or update.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar description: The description of this gallery Image Definition resource. This property is
updatable.
:vartype description: str
:ivar eula: The Eula agreement for the gallery Image Definition.
:vartype eula: str
:ivar privacy_statement_uri: The privacy statement uri.
:vartype privacy_statement_uri: str
:ivar release_note_uri: The release note uri.
:vartype release_note_uri: str
:ivar os_type: This property allows you to specify the type of the OS that is included in the
disk when creating a VM from a managed image. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known values are:
"Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar os_state: This property allows the user to specify whether the virtual machines created
under this image are 'Generalized' or 'Specialized'. Known values are: "Generalized" and
"Specialized".
:vartype os_state: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemStateTypes
:ivar end_of_life_date: The end of life date of the gallery Image Definition. This property can
be used for decommissioning purposes. This property is updatable.
:vartype end_of_life_date: ~datetime.datetime
:ivar identifier: This is the gallery Image Definition identifier.
:vartype identifier: ~azure.mgmt.compute.v2019_03_01.models.GalleryImageIdentifier
:ivar recommended: The properties describe the recommended machine configuration for this Image
Definition. These properties are updatable.
:vartype recommended: ~azure.mgmt.compute.v2019_03_01.models.RecommendedMachineConfiguration
:ivar disallowed: Describes the disallowed disk types.
:vartype disallowed: ~azure.mgmt.compute.v2019_03_01.models.Disallowed
:ivar purchase_plan: Describes the gallery Image Definition purchase plan. This is used by
marketplace images.
:vartype purchase_plan: ~azure.mgmt.compute.v2019_03_01.models.ImagePurchasePlan
:ivar provisioning_state: The provisioning state, which only appears in the response. Known
values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
:vartype provisioning_state: str or
~azure.mgmt.compute.v2019_03_01.models.GalleryImagePropertiesProvisioningState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"description": {"key": "properties.description", "type": "str"},
"eula": {"key": "properties.eula", "type": "str"},
"privacy_statement_uri": {"key": "properties.privacyStatementUri", "type": "str"},
"release_note_uri": {"key": "properties.releaseNoteUri", "type": "str"},
"os_type": {"key": "properties.osType", "type": "str"},
"os_state": {"key": "properties.osState", "type": "str"},
"end_of_life_date": {"key": "properties.endOfLifeDate", "type": "iso-8601"},
"identifier": {"key": "properties.identifier", "type": "GalleryImageIdentifier"},
"recommended": {"key": "properties.recommended", "type": "RecommendedMachineConfiguration"},
"disallowed": {"key": "properties.disallowed", "type": "Disallowed"},
"purchase_plan": {"key": "properties.purchasePlan", "type": "ImagePurchasePlan"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
description: Optional[str] = None,
eula: Optional[str] = None,
privacy_statement_uri: Optional[str] = None,
release_note_uri: Optional[str] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
os_state: Optional[Union[str, "_models.OperatingSystemStateTypes"]] = None,
end_of_life_date: Optional[datetime.datetime] = None,
identifier: Optional["_models.GalleryImageIdentifier"] = None,
recommended: Optional["_models.RecommendedMachineConfiguration"] = None,
disallowed: Optional["_models.Disallowed"] = None,
purchase_plan: Optional["_models.ImagePurchasePlan"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword description: The description of this gallery Image Definition resource. This property
is updatable.
:paramtype description: str
:keyword eula: The Eula agreement for the gallery Image Definition.
:paramtype eula: str
:keyword privacy_statement_uri: The privacy statement uri.
:paramtype privacy_statement_uri: str
:keyword release_note_uri: The release note uri.
:paramtype release_note_uri: str
:keyword os_type: This property allows you to specify the type of the OS that is included in
the disk when creating a VM from a managed image. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known values are:
"Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword os_state: This property allows the user to specify whether the virtual machines
created under this image are 'Generalized' or 'Specialized'. Known values are: "Generalized"
and "Specialized".
:paramtype os_state: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemStateTypes
:keyword end_of_life_date: The end of life date of the gallery Image Definition. This property
can be used for decommissioning purposes. This property is updatable.
:paramtype end_of_life_date: ~datetime.datetime
:keyword identifier: This is the gallery Image Definition identifier.
:paramtype identifier: ~azure.mgmt.compute.v2019_03_01.models.GalleryImageIdentifier
:keyword recommended: The properties describe the recommended machine configuration for this
Image Definition. These properties are updatable.
:paramtype recommended: ~azure.mgmt.compute.v2019_03_01.models.RecommendedMachineConfiguration
:keyword disallowed: Describes the disallowed disk types.
:paramtype disallowed: ~azure.mgmt.compute.v2019_03_01.models.Disallowed
:keyword purchase_plan: Describes the gallery Image Definition purchase plan. This is used by
marketplace images.
:paramtype purchase_plan: ~azure.mgmt.compute.v2019_03_01.models.ImagePurchasePlan
"""
super().__init__(location=location, tags=tags, **kwargs)
self.description = description
self.eula = eula
self.privacy_statement_uri = privacy_statement_uri
self.release_note_uri = release_note_uri
self.os_type = os_type
self.os_state = os_state
self.end_of_life_date = end_of_life_date
self.identifier = identifier
self.recommended = recommended
self.disallowed = disallowed
self.purchase_plan = purchase_plan
self.provisioning_state = None
[docs]class GalleryImageIdentifier(_serialization.Model):
"""This is the gallery Image Definition identifier.
All required parameters must be populated in order to send to Azure.
:ivar publisher: The name of the gallery Image Definition publisher. Required.
:vartype publisher: str
:ivar offer: The name of the gallery Image Definition offer. Required.
:vartype offer: str
:ivar sku: The name of the gallery Image Definition SKU. Required.
:vartype sku: str
"""
_validation = {
"publisher": {"required": True},
"offer": {"required": True},
"sku": {"required": True},
}
_attribute_map = {
"publisher": {"key": "publisher", "type": "str"},
"offer": {"key": "offer", "type": "str"},
"sku": {"key": "sku", "type": "str"},
}
def __init__(self, *, publisher: str, offer: str, sku: str, **kwargs: Any) -> None:
"""
:keyword publisher: The name of the gallery Image Definition publisher. Required.
:paramtype publisher: str
:keyword offer: The name of the gallery Image Definition offer. Required.
:paramtype offer: str
:keyword sku: The name of the gallery Image Definition SKU. Required.
:paramtype sku: str
"""
super().__init__(**kwargs)
self.publisher = publisher
self.offer = offer
self.sku = sku
[docs]class GalleryImageList(_serialization.Model):
"""The List Gallery Images operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of Shared Image Gallery images. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryImage]
:ivar next_link: The uri to fetch the next page of Image Definitions in the Shared Image
Gallery. Call ListNext() with this to fetch the next page of gallery Image Definitions.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[GalleryImage]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.GalleryImage"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: A list of Shared Image Gallery images. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryImage]
:keyword next_link: The uri to fetch the next page of Image Definitions in the Shared Image
Gallery. Call ListNext() with this to fetch the next page of gallery Image Definitions.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class GalleryImageVersion(Resource):
"""Specifies information about the gallery Image Version that you want to create or update.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar publishing_profile: The publishing profile of a gallery Image Version.
:vartype publishing_profile:
~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersionPublishingProfile
:ivar provisioning_state: The provisioning state, which only appears in the response. Known
values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
:vartype provisioning_state: str or
~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersionPropertiesProvisioningState
:ivar storage_profile: This is the storage profile of a Gallery Image Version.
:vartype storage_profile:
~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersionStorageProfile
:ivar replication_status: This is the replication status of the gallery Image Version.
:vartype replication_status: ~azure.mgmt.compute.v2019_03_01.models.ReplicationStatus
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
"storage_profile": {"readonly": True},
"replication_status": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"publishing_profile": {"key": "properties.publishingProfile", "type": "GalleryImageVersionPublishingProfile"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"storage_profile": {"key": "properties.storageProfile", "type": "GalleryImageVersionStorageProfile"},
"replication_status": {"key": "properties.replicationStatus", "type": "ReplicationStatus"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
publishing_profile: Optional["_models.GalleryImageVersionPublishingProfile"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword publishing_profile: The publishing profile of a gallery Image Version.
:paramtype publishing_profile:
~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersionPublishingProfile
"""
super().__init__(location=location, tags=tags, **kwargs)
self.publishing_profile = publishing_profile
self.provisioning_state = None
self.storage_profile = None
self.replication_status = None
[docs]class GalleryImageVersionList(_serialization.Model):
"""The List Gallery Image version operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of gallery Image Versions. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersion]
:ivar next_link: The uri to fetch the next page of gallery Image Versions. Call ListNext() with
this to fetch the next page of gallery Image Versions.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[GalleryImageVersion]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.GalleryImageVersion"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: A list of gallery Image Versions. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.GalleryImageVersion]
:keyword next_link: The uri to fetch the next page of gallery Image Versions. Call ListNext()
with this to fetch the next page of gallery Image Versions.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class GalleryImageVersionPublishingProfile(GalleryArtifactPublishingProfileBase):
"""The publishing profile of a gallery Image Version.
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.
:ivar target_regions: The target regions where the Image Version is going to be replicated to.
This property is updatable.
:vartype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:ivar replica_count: The number of replicas of the Image Version to be created per region. This
property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:vartype replica_count: int
:ivar exclude_from_latest: If set to true, Virtual Machines deployed from the latest version of
the Image Definition won't use this Image Version.
:vartype exclude_from_latest: bool
:ivar published_date: The timestamp for when the gallery Image Version is published.
:vartype published_date: ~datetime.datetime
:ivar end_of_life_date: The end of life date of the gallery Image Version. This property can be
used for decommissioning purposes. This property is updatable.
:vartype end_of_life_date: ~datetime.datetime
:ivar storage_account_type: Specifies the storage account type to be used to store the image.
This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:vartype storage_account_type: str or ~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
:ivar source: The source image from which the Image Version is going to be created. Required.
:vartype source: ~azure.mgmt.compute.v2019_03_01.models.GalleryArtifactSource
"""
_validation = {
"published_date": {"readonly": True},
"source": {"required": True},
}
_attribute_map = {
"target_regions": {"key": "targetRegions", "type": "[TargetRegion]"},
"replica_count": {"key": "replicaCount", "type": "int"},
"exclude_from_latest": {"key": "excludeFromLatest", "type": "bool"},
"published_date": {"key": "publishedDate", "type": "iso-8601"},
"end_of_life_date": {"key": "endOfLifeDate", "type": "iso-8601"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
"source": {"key": "source", "type": "GalleryArtifactSource"},
}
def __init__(
self,
*,
source: "_models.GalleryArtifactSource",
target_regions: Optional[List["_models.TargetRegion"]] = None,
replica_count: Optional[int] = None,
exclude_from_latest: Optional[bool] = None,
end_of_life_date: Optional[datetime.datetime] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountType"]] = None,
**kwargs: Any
) -> None:
"""
:keyword target_regions: The target regions where the Image Version is going to be replicated
to. This property is updatable.
:paramtype target_regions: list[~azure.mgmt.compute.v2019_03_01.models.TargetRegion]
:keyword replica_count: The number of replicas of the Image Version to be created per region.
This property would take effect for a region when regionalReplicaCount is not specified. This
property is updatable.
:paramtype replica_count: int
:keyword exclude_from_latest: If set to true, Virtual Machines deployed from the latest version
of the Image Definition won't use this Image Version.
:paramtype exclude_from_latest: bool
:keyword end_of_life_date: The end of life date of the gallery Image Version. This property can
be used for decommissioning purposes. This property is updatable.
:paramtype end_of_life_date: ~datetime.datetime
:keyword storage_account_type: Specifies the storage account type to be used to store the
image. This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
:keyword source: The source image from which the Image Version is going to be created.
Required.
:paramtype source: ~azure.mgmt.compute.v2019_03_01.models.GalleryArtifactSource
"""
super().__init__(
target_regions=target_regions,
replica_count=replica_count,
exclude_from_latest=exclude_from_latest,
end_of_life_date=end_of_life_date,
storage_account_type=storage_account_type,
**kwargs
)
self.source = source
[docs]class GalleryImageVersionStorageProfile(_serialization.Model):
"""This is the storage profile of a Gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar os_disk_image: This is the OS disk image.
:vartype os_disk_image: ~azure.mgmt.compute.v2019_03_01.models.GalleryOSDiskImage
:ivar data_disk_images: A list of data disk images.
:vartype data_disk_images: list[~azure.mgmt.compute.v2019_03_01.models.GalleryDataDiskImage]
"""
_validation = {
"os_disk_image": {"readonly": True},
"data_disk_images": {"readonly": True},
}
_attribute_map = {
"os_disk_image": {"key": "osDiskImage", "type": "GalleryOSDiskImage"},
"data_disk_images": {"key": "dataDiskImages", "type": "[GalleryDataDiskImage]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.os_disk_image = None
self.data_disk_images = None
[docs]class GalleryList(_serialization.Model):
"""The List Galleries operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of galleries. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.Gallery]
:ivar next_link: The uri to fetch the next page of galleries. Call ListNext() with this to
fetch the next page of galleries.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Gallery]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.Gallery"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: A list of galleries. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.Gallery]
:keyword next_link: The uri to fetch the next page of galleries. Call ListNext() with this to
fetch the next page of galleries.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class GalleryOSDiskImage(GalleryDiskImage):
"""This is the OS disk image.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar size_in_gb: This property indicates the size of the VHD to be created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None', 'ReadOnly', and
'ReadWrite'. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype host_caching: str or ~azure.mgmt.compute.v2019_03_01.models.HostCaching
"""
_validation = {
"size_in_gb": {"readonly": True},
"host_caching": {"readonly": True},
}
_attribute_map = {
"size_in_gb": {"key": "sizeInGB", "type": "int"},
"host_caching": {"key": "hostCaching", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
[docs]class GrantAccessData(_serialization.Model):
"""Data used for requesting a SAS.
All required parameters must be populated in order to send to Azure.
:ivar access: Required. Known values are: "None", "Read", and "Write".
:vartype access: str or ~azure.mgmt.compute.v2019_03_01.models.AccessLevel
:ivar duration_in_seconds: Time duration in seconds until the SAS access expires. Required.
:vartype duration_in_seconds: int
"""
_validation = {
"access": {"required": True},
"duration_in_seconds": {"required": True},
}
_attribute_map = {
"access": {"key": "access", "type": "str"},
"duration_in_seconds": {"key": "durationInSeconds", "type": "int"},
}
def __init__(self, *, access: Union[str, "_models.AccessLevel"], duration_in_seconds: int, **kwargs: Any) -> None:
"""
:keyword access: Required. Known values are: "None", "Read", and "Write".
:paramtype access: str or ~azure.mgmt.compute.v2019_03_01.models.AccessLevel
:keyword duration_in_seconds: Time duration in seconds until the SAS access expires. Required.
:paramtype duration_in_seconds: int
"""
super().__init__(**kwargs)
self.access = access
self.duration_in_seconds = duration_in_seconds
[docs]class HardwareProfile(_serialization.Model):
"""Specifies the hardware settings for the virtual machine.
:ivar vm_size: Specifies the size of the virtual machine. For more information about virtual
machine sizes, see `Sizes for virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` The available VM sizes depend on region and availability set. For a
list of available sizes use these APIs: :code:`<br>`:code:`<br>` `List all available virtual
machine sizes in an availability set
<https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes>`_
:code:`<br>`:code:`<br>` `List all available virtual machine sizes in a region
<https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list>`_
:code:`<br>`:code:`<br>` `List all available virtual machine sizes for resizing
<https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes>`_. Known
values are: "Basic_A0", "Basic_A1", "Basic_A2", "Basic_A3", "Basic_A4", "Standard_A0",
"Standard_A1", "Standard_A2", "Standard_A3", "Standard_A4", "Standard_A5", "Standard_A6",
"Standard_A7", "Standard_A8", "Standard_A9", "Standard_A10", "Standard_A11", "Standard_A1_v2",
"Standard_A2_v2", "Standard_A4_v2", "Standard_A8_v2", "Standard_A2m_v2", "Standard_A4m_v2",
"Standard_A8m_v2", "Standard_B1s", "Standard_B1ms", "Standard_B2s", "Standard_B2ms",
"Standard_B4ms", "Standard_B8ms", "Standard_D1", "Standard_D2", "Standard_D3", "Standard_D4",
"Standard_D11", "Standard_D12", "Standard_D13", "Standard_D14", "Standard_D1_v2",
"Standard_D2_v2", "Standard_D3_v2", "Standard_D4_v2", "Standard_D5_v2", "Standard_D2_v3",
"Standard_D4_v3", "Standard_D8_v3", "Standard_D16_v3", "Standard_D32_v3", "Standard_D64_v3",
"Standard_D2s_v3", "Standard_D4s_v3", "Standard_D8s_v3", "Standard_D16s_v3",
"Standard_D32s_v3", "Standard_D64s_v3", "Standard_D11_v2", "Standard_D12_v2",
"Standard_D13_v2", "Standard_D14_v2", "Standard_D15_v2", "Standard_DS1", "Standard_DS2",
"Standard_DS3", "Standard_DS4", "Standard_DS11", "Standard_DS12", "Standard_DS13",
"Standard_DS14", "Standard_DS1_v2", "Standard_DS2_v2", "Standard_DS3_v2", "Standard_DS4_v2",
"Standard_DS5_v2", "Standard_DS11_v2", "Standard_DS12_v2", "Standard_DS13_v2",
"Standard_DS14_v2", "Standard_DS15_v2", "Standard_DS13-4_v2", "Standard_DS13-2_v2",
"Standard_DS14-8_v2", "Standard_DS14-4_v2", "Standard_E2_v3", "Standard_E4_v3",
"Standard_E8_v3", "Standard_E16_v3", "Standard_E32_v3", "Standard_E64_v3", "Standard_E2s_v3",
"Standard_E4s_v3", "Standard_E8s_v3", "Standard_E16s_v3", "Standard_E32s_v3",
"Standard_E64s_v3", "Standard_E32-16_v3", "Standard_E32-8s_v3", "Standard_E64-32s_v3",
"Standard_E64-16s_v3", "Standard_F1", "Standard_F2", "Standard_F4", "Standard_F8",
"Standard_F16", "Standard_F1s", "Standard_F2s", "Standard_F4s", "Standard_F8s",
"Standard_F16s", "Standard_F2s_v2", "Standard_F4s_v2", "Standard_F8s_v2", "Standard_F16s_v2",
"Standard_F32s_v2", "Standard_F64s_v2", "Standard_F72s_v2", "Standard_G1", "Standard_G2",
"Standard_G3", "Standard_G4", "Standard_G5", "Standard_GS1", "Standard_GS2", "Standard_GS3",
"Standard_GS4", "Standard_GS5", "Standard_GS4-8", "Standard_GS4-4", "Standard_GS5-16",
"Standard_GS5-8", "Standard_H8", "Standard_H16", "Standard_H8m", "Standard_H16m",
"Standard_H16r", "Standard_H16mr", "Standard_L4s", "Standard_L8s", "Standard_L16s",
"Standard_L32s", "Standard_M64s", "Standard_M64ms", "Standard_M128s", "Standard_M128ms",
"Standard_M64-32ms", "Standard_M64-16ms", "Standard_M128-64ms", "Standard_M128-32ms",
"Standard_NC6", "Standard_NC12", "Standard_NC24", "Standard_NC24r", "Standard_NC6s_v2",
"Standard_NC12s_v2", "Standard_NC24s_v2", "Standard_NC24rs_v2", "Standard_NC6s_v3",
"Standard_NC12s_v3", "Standard_NC24s_v3", "Standard_NC24rs_v3", "Standard_ND6s",
"Standard_ND12s", "Standard_ND24s", "Standard_ND24rs", "Standard_NV6", "Standard_NV12", and
"Standard_NV24".
:vartype vm_size: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSizeTypes
"""
_attribute_map = {
"vm_size": {"key": "vmSize", "type": "str"},
}
def __init__(
self, *, vm_size: Optional[Union[str, "_models.VirtualMachineSizeTypes"]] = None, **kwargs: Any
) -> None:
"""
:keyword vm_size: Specifies the size of the virtual machine. For more information about virtual
machine sizes, see `Sizes for virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` The available VM sizes depend on region and availability set. For a
list of available sizes use these APIs: :code:`<br>`:code:`<br>` `List all available virtual
machine sizes in an availability set
<https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes>`_
:code:`<br>`:code:`<br>` `List all available virtual machine sizes in a region
<https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list>`_
:code:`<br>`:code:`<br>` `List all available virtual machine sizes for resizing
<https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes>`_. Known
values are: "Basic_A0", "Basic_A1", "Basic_A2", "Basic_A3", "Basic_A4", "Standard_A0",
"Standard_A1", "Standard_A2", "Standard_A3", "Standard_A4", "Standard_A5", "Standard_A6",
"Standard_A7", "Standard_A8", "Standard_A9", "Standard_A10", "Standard_A11", "Standard_A1_v2",
"Standard_A2_v2", "Standard_A4_v2", "Standard_A8_v2", "Standard_A2m_v2", "Standard_A4m_v2",
"Standard_A8m_v2", "Standard_B1s", "Standard_B1ms", "Standard_B2s", "Standard_B2ms",
"Standard_B4ms", "Standard_B8ms", "Standard_D1", "Standard_D2", "Standard_D3", "Standard_D4",
"Standard_D11", "Standard_D12", "Standard_D13", "Standard_D14", "Standard_D1_v2",
"Standard_D2_v2", "Standard_D3_v2", "Standard_D4_v2", "Standard_D5_v2", "Standard_D2_v3",
"Standard_D4_v3", "Standard_D8_v3", "Standard_D16_v3", "Standard_D32_v3", "Standard_D64_v3",
"Standard_D2s_v3", "Standard_D4s_v3", "Standard_D8s_v3", "Standard_D16s_v3",
"Standard_D32s_v3", "Standard_D64s_v3", "Standard_D11_v2", "Standard_D12_v2",
"Standard_D13_v2", "Standard_D14_v2", "Standard_D15_v2", "Standard_DS1", "Standard_DS2",
"Standard_DS3", "Standard_DS4", "Standard_DS11", "Standard_DS12", "Standard_DS13",
"Standard_DS14", "Standard_DS1_v2", "Standard_DS2_v2", "Standard_DS3_v2", "Standard_DS4_v2",
"Standard_DS5_v2", "Standard_DS11_v2", "Standard_DS12_v2", "Standard_DS13_v2",
"Standard_DS14_v2", "Standard_DS15_v2", "Standard_DS13-4_v2", "Standard_DS13-2_v2",
"Standard_DS14-8_v2", "Standard_DS14-4_v2", "Standard_E2_v3", "Standard_E4_v3",
"Standard_E8_v3", "Standard_E16_v3", "Standard_E32_v3", "Standard_E64_v3", "Standard_E2s_v3",
"Standard_E4s_v3", "Standard_E8s_v3", "Standard_E16s_v3", "Standard_E32s_v3",
"Standard_E64s_v3", "Standard_E32-16_v3", "Standard_E32-8s_v3", "Standard_E64-32s_v3",
"Standard_E64-16s_v3", "Standard_F1", "Standard_F2", "Standard_F4", "Standard_F8",
"Standard_F16", "Standard_F1s", "Standard_F2s", "Standard_F4s", "Standard_F8s",
"Standard_F16s", "Standard_F2s_v2", "Standard_F4s_v2", "Standard_F8s_v2", "Standard_F16s_v2",
"Standard_F32s_v2", "Standard_F64s_v2", "Standard_F72s_v2", "Standard_G1", "Standard_G2",
"Standard_G3", "Standard_G4", "Standard_G5", "Standard_GS1", "Standard_GS2", "Standard_GS3",
"Standard_GS4", "Standard_GS5", "Standard_GS4-8", "Standard_GS4-4", "Standard_GS5-16",
"Standard_GS5-8", "Standard_H8", "Standard_H16", "Standard_H8m", "Standard_H16m",
"Standard_H16r", "Standard_H16mr", "Standard_L4s", "Standard_L8s", "Standard_L16s",
"Standard_L32s", "Standard_M64s", "Standard_M64ms", "Standard_M128s", "Standard_M128ms",
"Standard_M64-32ms", "Standard_M64-16ms", "Standard_M128-64ms", "Standard_M128-32ms",
"Standard_NC6", "Standard_NC12", "Standard_NC24", "Standard_NC24r", "Standard_NC6s_v2",
"Standard_NC12s_v2", "Standard_NC24s_v2", "Standard_NC24rs_v2", "Standard_NC6s_v3",
"Standard_NC12s_v3", "Standard_NC24s_v3", "Standard_NC24rs_v3", "Standard_ND6s",
"Standard_ND12s", "Standard_ND24s", "Standard_ND24rs", "Standard_NV6", "Standard_NV12", and
"Standard_NV24".
:paramtype vm_size: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSizeTypes
"""
super().__init__(**kwargs)
self.vm_size = vm_size
[docs]class Image(Resource):
"""The source user image virtual hard disk. The virtual hard disk will be copied before being
attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive
must not exist.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar source_virtual_machine: The source virtual machine from which Image is created.
:vartype source_virtual_machine: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.ImageStorageProfile
:ivar provisioning_state: The provisioning state.
:vartype provisioning_state: str
:ivar hyper_v_generation: Gets the HyperVGenerationType of the VirtualMachine created from the
image. Known values are: "V1" and "V2".
:vartype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"source_virtual_machine": {"key": "properties.sourceVirtualMachine", "type": "SubResource"},
"storage_profile": {"key": "properties.storageProfile", "type": "ImageStorageProfile"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"hyper_v_generation": {"key": "properties.hyperVGeneration", "type": "str"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
source_virtual_machine: Optional["_models.SubResource"] = None,
storage_profile: Optional["_models.ImageStorageProfile"] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGenerationTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword source_virtual_machine: The source virtual machine from which Image is created.
:paramtype source_virtual_machine: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.ImageStorageProfile
:keyword hyper_v_generation: Gets the HyperVGenerationType of the VirtualMachine created from
the image. Known values are: "V1" and "V2".
:paramtype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
super().__init__(location=location, tags=tags, **kwargs)
self.source_virtual_machine = source_virtual_machine
self.storage_profile = storage_profile
self.provisioning_state = None
self.hyper_v_generation = hyper_v_generation
[docs]class ImageDataDisk(_serialization.Model):
"""Describes a data disk.
All required parameters must be populated in order to send to Azure.
:ivar lun: Specifies the logical unit number of the data disk. This value is used to identify
data disks within the VM and therefore must be unique for each data disk attached to a VM.
Required.
:vartype lun: int
:ivar snapshot: The snapshot.
:vartype snapshot: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar managed_disk: The managedDisk.
:vartype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar blob_uri: The Virtual Hard Disk.
:vartype blob_uri: str
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar storage_account_type: Specifies the storage account type for the managed disk. NOTE:
UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values
are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:vartype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
_validation = {
"lun": {"required": True},
}
_attribute_map = {
"lun": {"key": "lun", "type": "int"},
"snapshot": {"key": "snapshot", "type": "SubResource"},
"managed_disk": {"key": "managedDisk", "type": "SubResource"},
"blob_uri": {"key": "blobUri", "type": "str"},
"caching": {"key": "caching", "type": "str"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
lun: int,
snapshot: Optional["_models.SubResource"] = None,
managed_disk: Optional["_models.SubResource"] = None,
blob_uri: Optional[str] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword lun: Specifies the logical unit number of the data disk. This value is used to
identify data disks within the VM and therefore must be unique for each data disk attached to a
VM. Required.
:paramtype lun: int
:keyword snapshot: The snapshot.
:paramtype snapshot: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword managed_disk: The managedDisk.
:paramtype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword blob_uri: The Virtual Hard Disk.
:paramtype blob_uri: str
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword storage_account_type: Specifies the storage account type for the managed disk. NOTE:
UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values
are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
super().__init__(**kwargs)
self.lun = lun
self.snapshot = snapshot
self.managed_disk = managed_disk
self.blob_uri = blob_uri
self.caching = caching
self.disk_size_gb = disk_size_gb
self.storage_account_type = storage_account_type
[docs]class ImageDiskReference(_serialization.Model):
"""The source image used for creating the disk.
All required parameters must be populated in order to send to Azure.
:ivar id: A relative uri containing either a Platform Image Repository or user image reference.
Required.
:vartype id: str
:ivar lun: If the disk is created from an image's data disk, this is an index that indicates
which of the data disks in the image to use. For OS disks, this field is null.
:vartype lun: int
"""
_validation = {
"id": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"lun": {"key": "lun", "type": "int"},
}
def __init__(
self, *, id: str, lun: Optional[int] = None, **kwargs: Any # pylint: disable=redefined-builtin
) -> None:
"""
:keyword id: A relative uri containing either a Platform Image Repository or user image
reference. Required.
:paramtype id: str
:keyword lun: If the disk is created from an image's data disk, this is an index that indicates
which of the data disks in the image to use. For OS disks, this field is null.
:paramtype lun: int
"""
super().__init__(**kwargs)
self.id = id
self.lun = lun
[docs]class ImageListResult(_serialization.Model):
"""The List Image operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of Images. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.Image]
:ivar next_link: The uri to fetch the next page of Images. Call ListNext() with this to fetch
the next page of Images.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Image]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.Image"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: The list of Images. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.Image]
:keyword next_link: The uri to fetch the next page of Images. Call ListNext() with this to
fetch the next page of Images.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ImageOSDisk(_serialization.Model):
"""Describes an Operating System disk.
All required parameters must be populated in order to send to Azure.
:ivar os_type: This property allows you to specify the type of the OS that is included in the
disk if creating a VM from a custom image. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Required. Known values
are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar os_state: The OS State. Required. Known values are: "Generalized" and "Specialized".
:vartype os_state: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemStateTypes
:ivar snapshot: The snapshot.
:vartype snapshot: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar managed_disk: The managedDisk.
:vartype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar blob_uri: The Virtual Hard Disk.
:vartype blob_uri: str
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar storage_account_type: Specifies the storage account type for the managed disk.
UltraSSD_LRS cannot be used with OS Disk. Known values are: "Standard_LRS", "Premium_LRS",
"StandardSSD_LRS", and "UltraSSD_LRS".
:vartype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
_validation = {
"os_type": {"required": True},
"os_state": {"required": True},
}
_attribute_map = {
"os_type": {"key": "osType", "type": "str"},
"os_state": {"key": "osState", "type": "str"},
"snapshot": {"key": "snapshot", "type": "SubResource"},
"managed_disk": {"key": "managedDisk", "type": "SubResource"},
"blob_uri": {"key": "blobUri", "type": "str"},
"caching": {"key": "caching", "type": "str"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
os_type: Union[str, "_models.OperatingSystemTypes"],
os_state: Union[str, "_models.OperatingSystemStateTypes"],
snapshot: Optional["_models.SubResource"] = None,
managed_disk: Optional["_models.SubResource"] = None,
blob_uri: Optional[str] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword os_type: This property allows you to specify the type of the OS that is included in
the disk if creating a VM from a custom image. :code:`<br>`:code:`<br>` Possible values are:
:code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Required. Known values
are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword os_state: The OS State. Required. Known values are: "Generalized" and "Specialized".
:paramtype os_state: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemStateTypes
:keyword snapshot: The snapshot.
:paramtype snapshot: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword managed_disk: The managedDisk.
:paramtype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword blob_uri: The Virtual Hard Disk.
:paramtype blob_uri: str
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword storage_account_type: Specifies the storage account type for the managed disk.
UltraSSD_LRS cannot be used with OS Disk. Known values are: "Standard_LRS", "Premium_LRS",
"StandardSSD_LRS", and "UltraSSD_LRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
super().__init__(**kwargs)
self.os_type = os_type
self.os_state = os_state
self.snapshot = snapshot
self.managed_disk = managed_disk
self.blob_uri = blob_uri
self.caching = caching
self.disk_size_gb = disk_size_gb
self.storage_account_type = storage_account_type
[docs]class ImagePurchasePlan(_serialization.Model):
"""Describes the gallery Image Definition purchase plan. This is used by marketplace images.
:ivar name: The plan ID.
:vartype name: str
:ivar publisher: The publisher ID.
:vartype publisher: str
:ivar product: The product ID.
:vartype product: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"publisher": {"key": "publisher", "type": "str"},
"product": {"key": "product", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
publisher: Optional[str] = None,
product: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The plan ID.
:paramtype name: str
:keyword publisher: The publisher ID.
:paramtype publisher: str
:keyword product: The product ID.
:paramtype product: str
"""
super().__init__(**kwargs)
self.name = name
self.publisher = publisher
self.product = product
[docs]class SubResource(_serialization.Model):
"""SubResource.
:ivar id: Resource Id.
:vartype id: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: Optional[str] = None, **kwargs: Any) -> None: # pylint: disable=redefined-builtin
"""
:keyword id: Resource Id.
:paramtype id: str
"""
super().__init__(**kwargs)
self.id = id
[docs]class ImageReference(SubResource):
"""Specifies information about the image to use. You can specify information about platform
images, marketplace images, or virtual machine images. This element is required when you want
to use a platform image, marketplace image, or virtual machine image, but is not used in other
creation operations. NOTE: Image reference publisher and offer can only be set when you create
the scale set.
:ivar id: Resource Id.
:vartype id: str
:ivar publisher: The image publisher.
:vartype publisher: str
:ivar offer: Specifies the offer of the platform image or marketplace image used to create the
virtual machine.
:vartype offer: str
:ivar sku: The image SKU.
:vartype sku: str
:ivar version: Specifies the version of the platform image or marketplace image used to create
the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and
Build are decimal numbers. Specify 'latest' to use the latest version of an image available at
deploy time. Even if you use 'latest', the VM image will not automatically update after deploy
time even if a new version becomes available.
:vartype version: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"publisher": {"key": "publisher", "type": "str"},
"offer": {"key": "offer", "type": "str"},
"sku": {"key": "sku", "type": "str"},
"version": {"key": "version", "type": "str"},
}
def __init__(
self,
*,
id: Optional[str] = None, # pylint: disable=redefined-builtin
publisher: Optional[str] = None,
offer: Optional[str] = None,
sku: Optional[str] = None,
version: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword publisher: The image publisher.
:paramtype publisher: str
:keyword offer: Specifies the offer of the platform image or marketplace image used to create
the virtual machine.
:paramtype offer: str
:keyword sku: The image SKU.
:paramtype sku: str
:keyword version: Specifies the version of the platform image or marketplace image used to
create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major,
Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image
available at deploy time. Even if you use 'latest', the VM image will not automatically update
after deploy time even if a new version becomes available.
:paramtype version: str
"""
super().__init__(id=id, **kwargs)
self.publisher = publisher
self.offer = offer
self.sku = sku
self.version = version
[docs]class ImageStorageProfile(_serialization.Model):
"""Describes a storage profile.
:ivar os_disk: Specifies information about the operating system disk used by the virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype os_disk: ~azure.mgmt.compute.v2019_03_01.models.ImageOSDisk
:ivar data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype data_disks: list[~azure.mgmt.compute.v2019_03_01.models.ImageDataDisk]
:ivar zone_resilient: Specifies whether an image is zone resilient or not. Default is false.
Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
:vartype zone_resilient: bool
"""
_attribute_map = {
"os_disk": {"key": "osDisk", "type": "ImageOSDisk"},
"data_disks": {"key": "dataDisks", "type": "[ImageDataDisk]"},
"zone_resilient": {"key": "zoneResilient", "type": "bool"},
}
def __init__(
self,
*,
os_disk: Optional["_models.ImageOSDisk"] = None,
data_disks: Optional[List["_models.ImageDataDisk"]] = None,
zone_resilient: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword os_disk: Specifies information about the operating system disk used by the virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype os_disk: ~azure.mgmt.compute.v2019_03_01.models.ImageOSDisk
:keyword data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype data_disks: list[~azure.mgmt.compute.v2019_03_01.models.ImageDataDisk]
:keyword zone_resilient: Specifies whether an image is zone resilient or not. Default is false.
Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
:paramtype zone_resilient: bool
"""
super().__init__(**kwargs)
self.os_disk = os_disk
self.data_disks = data_disks
self.zone_resilient = zone_resilient
[docs]class ImageUpdate(UpdateResource):
"""The source user image virtual hard disk. Only tags may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar source_virtual_machine: The source virtual machine from which Image is created.
:vartype source_virtual_machine: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.ImageStorageProfile
:ivar provisioning_state: The provisioning state.
:vartype provisioning_state: str
:ivar hyper_v_generation: Gets the HyperVGenerationType of the VirtualMachine created from the
image. Known values are: "V1" and "V2".
:vartype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
_validation = {
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"source_virtual_machine": {"key": "properties.sourceVirtualMachine", "type": "SubResource"},
"storage_profile": {"key": "properties.storageProfile", "type": "ImageStorageProfile"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"hyper_v_generation": {"key": "properties.hyperVGeneration", "type": "str"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
source_virtual_machine: Optional["_models.SubResource"] = None,
storage_profile: Optional["_models.ImageStorageProfile"] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGenerationTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword source_virtual_machine: The source virtual machine from which Image is created.
:paramtype source_virtual_machine: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.ImageStorageProfile
:keyword hyper_v_generation: Gets the HyperVGenerationType of the VirtualMachine created from
the image. Known values are: "V1" and "V2".
:paramtype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
super().__init__(tags=tags, **kwargs)
self.source_virtual_machine = source_virtual_machine
self.storage_profile = storage_profile
self.provisioning_state = None
self.hyper_v_generation = hyper_v_generation
[docs]class InnerError(_serialization.Model):
"""Inner error details.
:ivar exceptiontype: The exception type.
:vartype exceptiontype: str
:ivar errordetail: The internal error message or exception dump.
:vartype errordetail: str
"""
_attribute_map = {
"exceptiontype": {"key": "exceptiontype", "type": "str"},
"errordetail": {"key": "errordetail", "type": "str"},
}
def __init__(
self, *, exceptiontype: Optional[str] = None, errordetail: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword exceptiontype: The exception type.
:paramtype exceptiontype: str
:keyword errordetail: The internal error message or exception dump.
:paramtype errordetail: str
"""
super().__init__(**kwargs)
self.exceptiontype = exceptiontype
self.errordetail = errordetail
[docs]class InstanceViewStatus(_serialization.Model):
"""Instance view status.
:ivar code: The status code.
:vartype code: str
:ivar level: The level code. Known values are: "Info", "Warning", and "Error".
:vartype level: str or ~azure.mgmt.compute.v2019_03_01.models.StatusLevelTypes
:ivar display_status: The short localizable label for the status.
:vartype display_status: str
:ivar message: The detailed status message, including for alerts and error messages.
:vartype message: str
:ivar time: The time of the status.
:vartype time: ~datetime.datetime
"""
_attribute_map = {
"code": {"key": "code", "type": "str"},
"level": {"key": "level", "type": "str"},
"display_status": {"key": "displayStatus", "type": "str"},
"message": {"key": "message", "type": "str"},
"time": {"key": "time", "type": "iso-8601"},
}
def __init__(
self,
*,
code: Optional[str] = None,
level: Optional[Union[str, "_models.StatusLevelTypes"]] = None,
display_status: Optional[str] = None,
message: Optional[str] = None,
time: Optional[datetime.datetime] = None,
**kwargs: Any
) -> None:
"""
:keyword code: The status code.
:paramtype code: str
:keyword level: The level code. Known values are: "Info", "Warning", and "Error".
:paramtype level: str or ~azure.mgmt.compute.v2019_03_01.models.StatusLevelTypes
:keyword display_status: The short localizable label for the status.
:paramtype display_status: str
:keyword message: The detailed status message, including for alerts and error messages.
:paramtype message: str
:keyword time: The time of the status.
:paramtype time: ~datetime.datetime
"""
super().__init__(**kwargs)
self.code = code
self.level = level
self.display_status = display_status
self.message = message
self.time = time
[docs]class KeyVaultAndKeyReference(_serialization.Model):
"""Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the
encryptionKey.
All required parameters must be populated in order to send to Azure.
:ivar source_vault: Resource id of the KeyVault containing the key or secret. Required.
:vartype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SourceVault
:ivar key_url: Url pointing to a key or secret in KeyVault. Required.
:vartype key_url: str
"""
_validation = {
"source_vault": {"required": True},
"key_url": {"required": True},
}
_attribute_map = {
"source_vault": {"key": "sourceVault", "type": "SourceVault"},
"key_url": {"key": "keyUrl", "type": "str"},
}
def __init__(self, *, source_vault: "_models.SourceVault", key_url: str, **kwargs: Any) -> None:
"""
:keyword source_vault: Resource id of the KeyVault containing the key or secret. Required.
:paramtype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SourceVault
:keyword key_url: Url pointing to a key or secret in KeyVault. Required.
:paramtype key_url: str
"""
super().__init__(**kwargs)
self.source_vault = source_vault
self.key_url = key_url
[docs]class KeyVaultAndSecretReference(_serialization.Model):
"""Key Vault Secret Url and vault id of the encryption key.
All required parameters must be populated in order to send to Azure.
:ivar source_vault: Resource id of the KeyVault containing the key or secret. Required.
:vartype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SourceVault
:ivar secret_url: Url pointing to a key or secret in KeyVault. Required.
:vartype secret_url: str
"""
_validation = {
"source_vault": {"required": True},
"secret_url": {"required": True},
}
_attribute_map = {
"source_vault": {"key": "sourceVault", "type": "SourceVault"},
"secret_url": {"key": "secretUrl", "type": "str"},
}
def __init__(self, *, source_vault: "_models.SourceVault", secret_url: str, **kwargs: Any) -> None:
"""
:keyword source_vault: Resource id of the KeyVault containing the key or secret. Required.
:paramtype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SourceVault
:keyword secret_url: Url pointing to a key or secret in KeyVault. Required.
:paramtype secret_url: str
"""
super().__init__(**kwargs)
self.source_vault = source_vault
self.secret_url = secret_url
[docs]class KeyVaultKeyReference(_serialization.Model):
"""Describes a reference to Key Vault Key.
All required parameters must be populated in order to send to Azure.
:ivar key_url: The URL referencing a key encryption key in Key Vault. Required.
:vartype key_url: str
:ivar source_vault: The relative URL of the Key Vault containing the key. Required.
:vartype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
_validation = {
"key_url": {"required": True},
"source_vault": {"required": True},
}
_attribute_map = {
"key_url": {"key": "keyUrl", "type": "str"},
"source_vault": {"key": "sourceVault", "type": "SubResource"},
}
def __init__(self, *, key_url: str, source_vault: "_models.SubResource", **kwargs: Any) -> None:
"""
:keyword key_url: The URL referencing a key encryption key in Key Vault. Required.
:paramtype key_url: str
:keyword source_vault: The relative URL of the Key Vault containing the key. Required.
:paramtype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(**kwargs)
self.key_url = key_url
self.source_vault = source_vault
[docs]class KeyVaultSecretReference(_serialization.Model):
"""Describes a reference to Key Vault Secret.
All required parameters must be populated in order to send to Azure.
:ivar secret_url: The URL referencing a secret in a Key Vault. Required.
:vartype secret_url: str
:ivar source_vault: The relative URL of the Key Vault containing the secret. Required.
:vartype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
_validation = {
"secret_url": {"required": True},
"source_vault": {"required": True},
}
_attribute_map = {
"secret_url": {"key": "secretUrl", "type": "str"},
"source_vault": {"key": "sourceVault", "type": "SubResource"},
}
def __init__(self, *, secret_url: str, source_vault: "_models.SubResource", **kwargs: Any) -> None:
"""
:keyword secret_url: The URL referencing a secret in a Key Vault. Required.
:paramtype secret_url: str
:keyword source_vault: The relative URL of the Key Vault containing the secret. Required.
:paramtype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(**kwargs)
self.secret_url = secret_url
self.source_vault = source_vault
[docs]class LinuxConfiguration(_serialization.Model):
"""Specifies the Linux operating system settings on the virtual machine.
:code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for
Non-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:ivar disable_password_authentication: Specifies whether password authentication should be
disabled.
:vartype disable_password_authentication: bool
:ivar ssh: Specifies the ssh key configuration for a Linux OS.
:vartype ssh: ~azure.mgmt.compute.v2019_03_01.models.SshConfiguration
:ivar provision_vm_agent: Indicates whether virtual machine agent should be provisioned on the
virtual machine. :code:`<br>`:code:`<br>` When this property is not specified in the request
body, default behavior is to set it to true. This will ensure that VM Agent is installed on
the VM so that extensions can be added to the VM later.
:vartype provision_vm_agent: bool
"""
_attribute_map = {
"disable_password_authentication": {"key": "disablePasswordAuthentication", "type": "bool"},
"ssh": {"key": "ssh", "type": "SshConfiguration"},
"provision_vm_agent": {"key": "provisionVMAgent", "type": "bool"},
}
def __init__(
self,
*,
disable_password_authentication: Optional[bool] = None,
ssh: Optional["_models.SshConfiguration"] = None,
provision_vm_agent: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword disable_password_authentication: Specifies whether password authentication should be
disabled.
:paramtype disable_password_authentication: bool
:keyword ssh: Specifies the ssh key configuration for a Linux OS.
:paramtype ssh: ~azure.mgmt.compute.v2019_03_01.models.SshConfiguration
:keyword provision_vm_agent: Indicates whether virtual machine agent should be provisioned on
the virtual machine. :code:`<br>`:code:`<br>` When this property is not specified in the
request body, default behavior is to set it to true. This will ensure that VM Agent is
installed on the VM so that extensions can be added to the VM later.
:paramtype provision_vm_agent: bool
"""
super().__init__(**kwargs)
self.disable_password_authentication = disable_password_authentication
self.ssh = ssh
self.provision_vm_agent = provision_vm_agent
[docs]class ListUsagesResult(_serialization.Model):
"""The List Usages operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of compute resource usages. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.Usage]
:ivar next_link: The URI to fetch the next page of compute resource usage information. Call
ListNext() with this to fetch the next page of compute resource usage information.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Usage]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.Usage"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: The list of compute resource usages. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.Usage]
:keyword next_link: The URI to fetch the next page of compute resource usage information. Call
ListNext() with this to fetch the next page of compute resource usage information.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class LogAnalyticsOperationResult(_serialization.Model):
"""LogAnalytics operation status response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar properties: LogAnalyticsOutput.
:vartype properties: ~azure.mgmt.compute.v2019_03_01.models.LogAnalyticsOutput
"""
_validation = {
"properties": {"readonly": True},
}
_attribute_map = {
"properties": {"key": "properties", "type": "LogAnalyticsOutput"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.properties = None
[docs]class LogAnalyticsOutput(_serialization.Model):
"""LogAnalytics output properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar output: Output file Uri path to blob container.
:vartype output: str
"""
_validation = {
"output": {"readonly": True},
}
_attribute_map = {
"output": {"key": "output", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.output = None
[docs]class MaintenanceRedeployStatus(_serialization.Model):
"""Maintenance Operation Status.
:ivar is_customer_initiated_maintenance_allowed: True, if customer is allowed to perform
Maintenance.
:vartype is_customer_initiated_maintenance_allowed: bool
:ivar pre_maintenance_window_start_time: Start Time for the Pre Maintenance Window.
:vartype pre_maintenance_window_start_time: ~datetime.datetime
:ivar pre_maintenance_window_end_time: End Time for the Pre Maintenance Window.
:vartype pre_maintenance_window_end_time: ~datetime.datetime
:ivar maintenance_window_start_time: Start Time for the Maintenance Window.
:vartype maintenance_window_start_time: ~datetime.datetime
:ivar maintenance_window_end_time: End Time for the Maintenance Window.
:vartype maintenance_window_end_time: ~datetime.datetime
:ivar last_operation_result_code: The Last Maintenance Operation Result Code. Known values are:
"None", "RetryLater", "MaintenanceAborted", and "MaintenanceCompleted".
:vartype last_operation_result_code: str or
~azure.mgmt.compute.v2019_03_01.models.MaintenanceOperationResultCodeTypes
:ivar last_operation_message: Message returned for the last Maintenance Operation.
:vartype last_operation_message: str
"""
_attribute_map = {
"is_customer_initiated_maintenance_allowed": {"key": "isCustomerInitiatedMaintenanceAllowed", "type": "bool"},
"pre_maintenance_window_start_time": {"key": "preMaintenanceWindowStartTime", "type": "iso-8601"},
"pre_maintenance_window_end_time": {"key": "preMaintenanceWindowEndTime", "type": "iso-8601"},
"maintenance_window_start_time": {"key": "maintenanceWindowStartTime", "type": "iso-8601"},
"maintenance_window_end_time": {"key": "maintenanceWindowEndTime", "type": "iso-8601"},
"last_operation_result_code": {"key": "lastOperationResultCode", "type": "str"},
"last_operation_message": {"key": "lastOperationMessage", "type": "str"},
}
def __init__(
self,
*,
is_customer_initiated_maintenance_allowed: Optional[bool] = None,
pre_maintenance_window_start_time: Optional[datetime.datetime] = None,
pre_maintenance_window_end_time: Optional[datetime.datetime] = None,
maintenance_window_start_time: Optional[datetime.datetime] = None,
maintenance_window_end_time: Optional[datetime.datetime] = None,
last_operation_result_code: Optional[Union[str, "_models.MaintenanceOperationResultCodeTypes"]] = None,
last_operation_message: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword is_customer_initiated_maintenance_allowed: True, if customer is allowed to perform
Maintenance.
:paramtype is_customer_initiated_maintenance_allowed: bool
:keyword pre_maintenance_window_start_time: Start Time for the Pre Maintenance Window.
:paramtype pre_maintenance_window_start_time: ~datetime.datetime
:keyword pre_maintenance_window_end_time: End Time for the Pre Maintenance Window.
:paramtype pre_maintenance_window_end_time: ~datetime.datetime
:keyword maintenance_window_start_time: Start Time for the Maintenance Window.
:paramtype maintenance_window_start_time: ~datetime.datetime
:keyword maintenance_window_end_time: End Time for the Maintenance Window.
:paramtype maintenance_window_end_time: ~datetime.datetime
:keyword last_operation_result_code: The Last Maintenance Operation Result Code. Known values
are: "None", "RetryLater", "MaintenanceAborted", and "MaintenanceCompleted".
:paramtype last_operation_result_code: str or
~azure.mgmt.compute.v2019_03_01.models.MaintenanceOperationResultCodeTypes
:keyword last_operation_message: Message returned for the last Maintenance Operation.
:paramtype last_operation_message: str
"""
super().__init__(**kwargs)
self.is_customer_initiated_maintenance_allowed = is_customer_initiated_maintenance_allowed
self.pre_maintenance_window_start_time = pre_maintenance_window_start_time
self.pre_maintenance_window_end_time = pre_maintenance_window_end_time
self.maintenance_window_start_time = maintenance_window_start_time
self.maintenance_window_end_time = maintenance_window_end_time
self.last_operation_result_code = last_operation_result_code
self.last_operation_message = last_operation_message
[docs]class ManagedArtifact(_serialization.Model):
"""The managed artifact.
All required parameters must be populated in order to send to Azure.
:ivar id: The managed artifact id. Required.
:vartype id: str
"""
_validation = {
"id": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: str, **kwargs: Any) -> None: # pylint: disable=redefined-builtin
"""
:keyword id: The managed artifact id. Required.
:paramtype id: str
"""
super().__init__(**kwargs)
self.id = id
[docs]class ManagedDiskParameters(SubResource):
"""The parameters of a managed disk.
:ivar id: Resource Id.
:vartype id: str
:ivar storage_account_type: Specifies the storage account type for the managed disk. NOTE:
UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values
are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:vartype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
id: Optional[str] = None, # pylint: disable=redefined-builtin
storage_account_type: Optional[Union[str, "_models.StorageAccountTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword storage_account_type: Specifies the storage account type for the managed disk. NOTE:
UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Known values
are: "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
super().__init__(id=id, **kwargs)
self.storage_account_type = storage_account_type
[docs]class NetworkInterfaceReference(SubResource):
"""Describes a network interface reference.
:ivar id: Resource Id.
:vartype id: str
:ivar primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:vartype primary: bool
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"primary": {"key": "properties.primary", "type": "bool"},
}
def __init__(
self,
*,
id: Optional[str] = None, # pylint: disable=redefined-builtin
primary: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:paramtype primary: bool
"""
super().__init__(id=id, **kwargs)
self.primary = primary
[docs]class NetworkProfile(_serialization.Model):
"""Specifies the network interfaces of the virtual machine.
:ivar network_interfaces: Specifies the list of resource Ids for the network interfaces
associated with the virtual machine.
:vartype network_interfaces:
list[~azure.mgmt.compute.v2019_03_01.models.NetworkInterfaceReference]
"""
_attribute_map = {
"network_interfaces": {"key": "networkInterfaces", "type": "[NetworkInterfaceReference]"},
}
def __init__(
self, *, network_interfaces: Optional[List["_models.NetworkInterfaceReference"]] = None, **kwargs: Any
) -> None:
"""
:keyword network_interfaces: Specifies the list of resource Ids for the network interfaces
associated with the virtual machine.
:paramtype network_interfaces:
list[~azure.mgmt.compute.v2019_03_01.models.NetworkInterfaceReference]
"""
super().__init__(**kwargs)
self.network_interfaces = network_interfaces
[docs]class OSDisk(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""Specifies information about the operating system disk used by the virtual machine.
:code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs for Azure
virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
All required parameters must be populated in order to send to Azure.
:ivar os_type: This property allows you to specify the type of the OS that is included in the
disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>` Possible
values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known
values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar encryption_settings: Specifies the encryption settings for the OS Disk.
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype encryption_settings: ~azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings
:ivar name: The disk name.
:vartype name: str
:ivar vhd: The virtual hard disk.
:vartype vhd: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:vartype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:vartype write_accelerator_enabled: bool
:ivar diff_disk_settings: Specifies the ephemeral Disk Settings for the operating system disk
used by the virtual machine.
:vartype diff_disk_settings: ~azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings
:ivar create_option: Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Required. Known values are: "FromImage", "Empty", and
"Attach".
:vartype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:ivar disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar managed_disk: The managed disk parameters.
:vartype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.ManagedDiskParameters
"""
_validation = {
"create_option": {"required": True},
}
_attribute_map = {
"os_type": {"key": "osType", "type": "str"},
"encryption_settings": {"key": "encryptionSettings", "type": "DiskEncryptionSettings"},
"name": {"key": "name", "type": "str"},
"vhd": {"key": "vhd", "type": "VirtualHardDisk"},
"image": {"key": "image", "type": "VirtualHardDisk"},
"caching": {"key": "caching", "type": "str"},
"write_accelerator_enabled": {"key": "writeAcceleratorEnabled", "type": "bool"},
"diff_disk_settings": {"key": "diffDiskSettings", "type": "DiffDiskSettings"},
"create_option": {"key": "createOption", "type": "str"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"managed_disk": {"key": "managedDisk", "type": "ManagedDiskParameters"},
}
def __init__(
self,
*,
create_option: Union[str, "_models.DiskCreateOptionTypes"],
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
encryption_settings: Optional["_models.DiskEncryptionSettings"] = None,
name: Optional[str] = None,
vhd: Optional["_models.VirtualHardDisk"] = None,
image: Optional["_models.VirtualHardDisk"] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
write_accelerator_enabled: Optional[bool] = None,
diff_disk_settings: Optional["_models.DiffDiskSettings"] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["_models.ManagedDiskParameters"] = None,
**kwargs: Any
) -> None:
"""
:keyword os_type: This property allows you to specify the type of the OS that is included in
the disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>`
Possible values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**.
Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword encryption_settings: Specifies the encryption settings for the OS Disk.
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype encryption_settings: ~azure.mgmt.compute.v2019_03_01.models.DiskEncryptionSettings
:keyword name: The disk name.
:paramtype name: str
:keyword vhd: The virtual hard disk.
:paramtype vhd: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:paramtype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:paramtype write_accelerator_enabled: bool
:keyword diff_disk_settings: Specifies the ephemeral Disk Settings for the operating system
disk used by the virtual machine.
:paramtype diff_disk_settings: ~azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings
:keyword create_option: Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Required. Known values are: "FromImage", "Empty", and
"Attach".
:paramtype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:keyword disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can
be used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword managed_disk: The managed disk parameters.
:paramtype managed_disk: ~azure.mgmt.compute.v2019_03_01.models.ManagedDiskParameters
"""
super().__init__(**kwargs)
self.os_type = os_type
self.encryption_settings = encryption_settings
self.name = name
self.vhd = vhd
self.image = image
self.caching = caching
self.write_accelerator_enabled = write_accelerator_enabled
self.diff_disk_settings = diff_disk_settings
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
[docs]class OSDiskImage(_serialization.Model):
"""Contains the os disk image information.
All required parameters must be populated in order to send to Azure.
:ivar operating_system: The operating system of the osDiskImage. Required. Known values are:
"Windows" and "Linux".
:vartype operating_system: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
"""
_validation = {
"operating_system": {"required": True},
}
_attribute_map = {
"operating_system": {"key": "operatingSystem", "type": "str"},
}
def __init__(self, *, operating_system: Union[str, "_models.OperatingSystemTypes"], **kwargs: Any) -> None:
"""
:keyword operating_system: The operating system of the osDiskImage. Required. Known values are:
"Windows" and "Linux".
:paramtype operating_system: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
"""
super().__init__(**kwargs)
self.operating_system = operating_system
[docs]class OSProfile(_serialization.Model):
"""Specifies the operating system settings for the virtual machine.
:ivar computer_name: Specifies the host OS name of the virtual machine.
:code:`<br>`:code:`<br>` This name cannot be updated after the VM is created.
:code:`<br>`:code:`<br>` **Max-length (Windows):** 15 characters :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters. :code:`<br>`:code:`<br>` For naming conventions and
restrictions see `Azure infrastructure services implementation guidelines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions>`_.
:vartype computer_name: str
:ivar admin_username: Specifies the name of the administrator account. :code:`<br>`:code:`<br>`
**Windows-only restriction:** Cannot end in "." :code:`<br>`:code:`<br>` **Disallowed values:**
"administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1",
"123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest",
"john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2",
"test3", "user4", "user5". :code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character
:code:`<br>`:code:`<br>` **Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>`
**Max-length (Windows):** 20 characters :code:`<br>`:code:`<br>`:code:`<li>` For root access
to the Linux VM, see `Using root privileges on Linux virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_\
:code:`<br>`:code:`<li>` For a list of built-in system users on Linux that should not be used
in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype admin_username: str
:ivar admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` For resetting root password, see `Manage users, SSH, and check or
repair disks on Azure Linux VMs using the VMAccess Extension
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password>`_.
:vartype admin_password: str
:ivar custom_data: Specifies a base-64 encoded string of custom data. The base-64 encoded
string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum
length of the binary array is 65535 bytes. :code:`<br>`:code:`<br>` For using cloud-init for
your VM, see `Using cloud-init to customize a Linux VM during creation
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype custom_data: str
:ivar windows_configuration: Specifies Windows operating system settings on the virtual
machine.
:vartype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:ivar linux_configuration: Specifies the Linux operating system settings on the virtual
machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for
Non-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:ivar secrets: Specifies set of certificates that should be installed onto the virtual machine.
:vartype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
:ivar allow_extension_operations: Specifies whether extension operations should be allowed on
the virtual machine. :code:`<br>`:code:`<br>`This may only be set to False when no extensions
are present on the virtual machine.
:vartype allow_extension_operations: bool
:ivar require_guest_provision_signal: Specifies whether the guest provision signal is required
from the virtual machine.
:vartype require_guest_provision_signal: bool
"""
_attribute_map = {
"computer_name": {"key": "computerName", "type": "str"},
"admin_username": {"key": "adminUsername", "type": "str"},
"admin_password": {"key": "adminPassword", "type": "str"},
"custom_data": {"key": "customData", "type": "str"},
"windows_configuration": {"key": "windowsConfiguration", "type": "WindowsConfiguration"},
"linux_configuration": {"key": "linuxConfiguration", "type": "LinuxConfiguration"},
"secrets": {"key": "secrets", "type": "[VaultSecretGroup]"},
"allow_extension_operations": {"key": "allowExtensionOperations", "type": "bool"},
"require_guest_provision_signal": {"key": "requireGuestProvisionSignal", "type": "bool"},
}
def __init__(
self,
*,
computer_name: Optional[str] = None,
admin_username: Optional[str] = None,
admin_password: Optional[str] = None,
custom_data: Optional[str] = None,
windows_configuration: Optional["_models.WindowsConfiguration"] = None,
linux_configuration: Optional["_models.LinuxConfiguration"] = None,
secrets: Optional[List["_models.VaultSecretGroup"]] = None,
allow_extension_operations: Optional[bool] = None,
require_guest_provision_signal: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword computer_name: Specifies the host OS name of the virtual machine.
:code:`<br>`:code:`<br>` This name cannot be updated after the VM is created.
:code:`<br>`:code:`<br>` **Max-length (Windows):** 15 characters :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters. :code:`<br>`:code:`<br>` For naming conventions and
restrictions see `Azure infrastructure services implementation guidelines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions>`_.
:paramtype computer_name: str
:keyword admin_username: Specifies the name of the administrator account.
:code:`<br>`:code:`<br>` **Windows-only restriction:** Cannot end in "."
:code:`<br>`:code:`<br>` **Disallowed values:** "administrator", "admin", "user", "user1",
"test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2",
"aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql",
"support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
:code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 20
characters :code:`<br>`:code:`<br>`:code:`<li>` For root access to the Linux VM, see `Using
root privileges on Linux virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_\
:code:`<br>`:code:`<li>` For a list of built-in system users on Linux that should not be used
in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype admin_username: str
:keyword admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` For resetting root password, see `Manage users, SSH, and check or
repair disks on Azure Linux VMs using the VMAccess Extension
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password>`_.
:paramtype admin_password: str
:keyword custom_data: Specifies a base-64 encoded string of custom data. The base-64 encoded
string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum
length of the binary array is 65535 bytes. :code:`<br>`:code:`<br>` For using cloud-init for
your VM, see `Using cloud-init to customize a Linux VM during creation
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype custom_data: str
:keyword windows_configuration: Specifies Windows operating system settings on the virtual
machine.
:paramtype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:keyword linux_configuration: Specifies the Linux operating system settings on the virtual
machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for
Non-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:keyword secrets: Specifies set of certificates that should be installed onto the virtual
machine.
:paramtype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
:keyword allow_extension_operations: Specifies whether extension operations should be allowed
on the virtual machine. :code:`<br>`:code:`<br>`This may only be set to False when no
extensions are present on the virtual machine.
:paramtype allow_extension_operations: bool
:keyword require_guest_provision_signal: Specifies whether the guest provision signal is
required from the virtual machine.
:paramtype require_guest_provision_signal: bool
"""
super().__init__(**kwargs)
self.computer_name = computer_name
self.admin_username = admin_username
self.admin_password = admin_password
self.custom_data = custom_data
self.windows_configuration = windows_configuration
self.linux_configuration = linux_configuration
self.secrets = secrets
self.allow_extension_operations = allow_extension_operations
self.require_guest_provision_signal = require_guest_provision_signal
[docs]class Plan(_serialization.Model):
"""Specifies information about the marketplace image used to create the virtual machine. This
element is only used for marketplace images. Before you can use a marketplace image from an
API, you must enable the image for programmatic use. In the Azure portal, find the marketplace
image that you want to use and then click **Want to deploy programmatically, Get Started ->**.
Enter any required information and then click **Save**.
:ivar name: The plan ID.
:vartype name: str
:ivar publisher: The publisher ID.
:vartype publisher: str
:ivar product: Specifies the product of the image from the marketplace. This is the same value
as Offer under the imageReference element.
:vartype product: str
:ivar promotion_code: The promotion code.
:vartype promotion_code: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"publisher": {"key": "publisher", "type": "str"},
"product": {"key": "product", "type": "str"},
"promotion_code": {"key": "promotionCode", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
publisher: Optional[str] = None,
product: Optional[str] = None,
promotion_code: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The plan ID.
:paramtype name: str
:keyword publisher: The publisher ID.
:paramtype publisher: str
:keyword product: Specifies the product of the image from the marketplace. This is the same
value as Offer under the imageReference element.
:paramtype product: str
:keyword promotion_code: The promotion code.
:paramtype promotion_code: str
"""
super().__init__(**kwargs)
self.name = name
self.publisher = publisher
self.product = product
self.promotion_code = promotion_code
[docs]class ProximityPlacementGroup(Resource):
"""Specifies information about the proximity placement group.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar proximity_placement_group_type: Specifies the type of the proximity placement group.
:code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` **Standard** : Co-locate
resources within an Azure region or Availability Zone. :code:`<br>`:code:`<br>` **Ultra** : For
future use. Known values are: "Standard" and "Ultra".
:vartype proximity_placement_group_type: str or
~azure.mgmt.compute.v2019_03_01.models.ProximityPlacementGroupType
:ivar virtual_machines: A list of references to all virtual machines in the proximity placement
group.
:vartype virtual_machines: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar virtual_machine_scale_sets: A list of references to all virtual machine scale sets in the
proximity placement group.
:vartype virtual_machine_scale_sets: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar availability_sets: A list of references to all availability sets in the proximity
placement group.
:vartype availability_sets: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"virtual_machines": {"readonly": True},
"virtual_machine_scale_sets": {"readonly": True},
"availability_sets": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"proximity_placement_group_type": {"key": "properties.proximityPlacementGroupType", "type": "str"},
"virtual_machines": {"key": "properties.virtualMachines", "type": "[SubResource]"},
"virtual_machine_scale_sets": {"key": "properties.virtualMachineScaleSets", "type": "[SubResource]"},
"availability_sets": {"key": "properties.availabilitySets", "type": "[SubResource]"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
proximity_placement_group_type: Optional[Union[str, "_models.ProximityPlacementGroupType"]] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword proximity_placement_group_type: Specifies the type of the proximity placement group.
:code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` **Standard** : Co-locate
resources within an Azure region or Availability Zone. :code:`<br>`:code:`<br>` **Ultra** : For
future use. Known values are: "Standard" and "Ultra".
:paramtype proximity_placement_group_type: str or
~azure.mgmt.compute.v2019_03_01.models.ProximityPlacementGroupType
"""
super().__init__(location=location, tags=tags, **kwargs)
self.proximity_placement_group_type = proximity_placement_group_type
self.virtual_machines = None
self.virtual_machine_scale_sets = None
self.availability_sets = None
[docs]class ProximityPlacementGroupListResult(_serialization.Model):
"""The List Proximity Placement Group operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of proximity placement groups. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.ProximityPlacementGroup]
:ivar next_link: The URI to fetch the next page of proximity placement groups.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[ProximityPlacementGroup]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.ProximityPlacementGroup"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of proximity placement groups. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.ProximityPlacementGroup]
:keyword next_link: The URI to fetch the next page of proximity placement groups.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ProximityPlacementGroupUpdate(UpdateResource):
"""Specifies information about the proximity placement group.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, **kwargs)
[docs]class PurchasePlan(_serialization.Model):
"""Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
All required parameters must be populated in order to send to Azure.
:ivar publisher: The publisher ID. Required.
:vartype publisher: str
:ivar name: The plan ID. Required.
:vartype name: str
:ivar product: Specifies the product of the image from the marketplace. This is the same value
as Offer under the imageReference element. Required.
:vartype product: str
"""
_validation = {
"publisher": {"required": True},
"name": {"required": True},
"product": {"required": True},
}
_attribute_map = {
"publisher": {"key": "publisher", "type": "str"},
"name": {"key": "name", "type": "str"},
"product": {"key": "product", "type": "str"},
}
def __init__(self, *, publisher: str, name: str, product: str, **kwargs: Any) -> None:
"""
:keyword publisher: The publisher ID. Required.
:paramtype publisher: str
:keyword name: The plan ID. Required.
:paramtype name: str
:keyword product: Specifies the product of the image from the marketplace. This is the same
value as Offer under the imageReference element. Required.
:paramtype product: str
"""
super().__init__(**kwargs)
self.publisher = publisher
self.name = name
self.product = product
[docs]class RecommendedMachineConfiguration(_serialization.Model):
"""The properties describe the recommended machine configuration for this Image Definition. These
properties are updatable.
:ivar v_cp_us: Describes the resource range.
:vartype v_cp_us: ~azure.mgmt.compute.v2019_03_01.models.ResourceRange
:ivar memory: Describes the resource range.
:vartype memory: ~azure.mgmt.compute.v2019_03_01.models.ResourceRange
"""
_attribute_map = {
"v_cp_us": {"key": "vCPUs", "type": "ResourceRange"},
"memory": {"key": "memory", "type": "ResourceRange"},
}
def __init__(
self,
*,
v_cp_us: Optional["_models.ResourceRange"] = None,
memory: Optional["_models.ResourceRange"] = None,
**kwargs: Any
) -> None:
"""
:keyword v_cp_us: Describes the resource range.
:paramtype v_cp_us: ~azure.mgmt.compute.v2019_03_01.models.ResourceRange
:keyword memory: Describes the resource range.
:paramtype memory: ~azure.mgmt.compute.v2019_03_01.models.ResourceRange
"""
super().__init__(**kwargs)
self.v_cp_us = v_cp_us
self.memory = memory
[docs]class RecoveryWalkResponse(_serialization.Model):
"""Response after calling a manual recovery walk.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar walk_performed: Whether the recovery walk was performed.
:vartype walk_performed: bool
:ivar next_platform_update_domain: The next update domain that needs to be walked. Null means
walk spanning all update domains has been completed.
:vartype next_platform_update_domain: int
"""
_validation = {
"walk_performed": {"readonly": True},
"next_platform_update_domain": {"readonly": True},
}
_attribute_map = {
"walk_performed": {"key": "walkPerformed", "type": "bool"},
"next_platform_update_domain": {"key": "nextPlatformUpdateDomain", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.walk_performed = None
self.next_platform_update_domain = None
[docs]class RegionalReplicationStatus(_serialization.Model):
"""This is the regional replication status.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar region: The region to which the gallery Image Version is being replicated to.
:vartype region: str
:ivar state: This is the regional replication state. Known values are: "Unknown",
"Replicating", "Completed", and "Failed".
:vartype state: str or ~azure.mgmt.compute.v2019_03_01.models.ReplicationState
:ivar details: The details of the replication status.
:vartype details: str
:ivar progress: It indicates progress of the replication job.
:vartype progress: int
"""
_validation = {
"region": {"readonly": True},
"state": {"readonly": True},
"details": {"readonly": True},
"progress": {"readonly": True},
}
_attribute_map = {
"region": {"key": "region", "type": "str"},
"state": {"key": "state", "type": "str"},
"details": {"key": "details", "type": "str"},
"progress": {"key": "progress", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.region = None
self.state = None
self.details = None
self.progress = None
[docs]class ReplicationStatus(_serialization.Model):
"""This is the replication status of the gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar aggregated_state: This is the aggregated replication status based on all the regional
replication status flags. Known values are: "Unknown", "InProgress", "Completed", and "Failed".
:vartype aggregated_state: str or
~azure.mgmt.compute.v2019_03_01.models.AggregatedReplicationState
:ivar summary: This is a summary of replication status for each region.
:vartype summary: list[~azure.mgmt.compute.v2019_03_01.models.RegionalReplicationStatus]
"""
_validation = {
"aggregated_state": {"readonly": True},
"summary": {"readonly": True},
}
_attribute_map = {
"aggregated_state": {"key": "aggregatedState", "type": "str"},
"summary": {"key": "summary", "type": "[RegionalReplicationStatus]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.aggregated_state = None
self.summary = None
[docs]class ResourceRange(_serialization.Model):
"""Describes the resource range.
:ivar min: The minimum number of the resource.
:vartype min: int
:ivar max: The maximum number of the resource.
:vartype max: int
"""
_attribute_map = {
"min": {"key": "min", "type": "int"},
"max": {"key": "max", "type": "int"},
}
def __init__(
self,
*,
min: Optional[int] = None, # pylint: disable=redefined-builtin
max: Optional[int] = None, # pylint: disable=redefined-builtin
**kwargs: Any
) -> None:
"""
:keyword min: The minimum number of the resource.
:paramtype min: int
:keyword max: The maximum number of the resource.
:paramtype max: int
"""
super().__init__(**kwargs)
self.min = min
self.max = max
[docs]class RollbackStatusInfo(_serialization.Model):
"""Information about rollback on failed VM instances after a OS Upgrade operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar successfully_rolledback_instance_count: The number of instances which have been
successfully rolled back.
:vartype successfully_rolledback_instance_count: int
:ivar failed_rolledback_instance_count: The number of instances which failed to rollback.
:vartype failed_rolledback_instance_count: int
:ivar rollback_error: Error details if OS rollback failed.
:vartype rollback_error: ~azure.mgmt.compute.v2019_03_01.models.ApiError
"""
_validation = {
"successfully_rolledback_instance_count": {"readonly": True},
"failed_rolledback_instance_count": {"readonly": True},
"rollback_error": {"readonly": True},
}
_attribute_map = {
"successfully_rolledback_instance_count": {"key": "successfullyRolledbackInstanceCount", "type": "int"},
"failed_rolledback_instance_count": {"key": "failedRolledbackInstanceCount", "type": "int"},
"rollback_error": {"key": "rollbackError", "type": "ApiError"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.successfully_rolledback_instance_count = None
self.failed_rolledback_instance_count = None
self.rollback_error = None
[docs]class RollingUpgradePolicy(_serialization.Model):
"""The configuration parameters used while performing a rolling upgrade.
:ivar max_batch_instance_percent: The maximum percent of total virtual machine instances that
will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum,
unhealthy instances in previous or future batches can cause the percentage of instances in a
batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
:vartype max_batch_instance_percent: int
:ivar max_unhealthy_instance_percent: The maximum percentage of the total virtual machine
instances in the scale set that can be simultaneously unhealthy, either as a result of being
upgraded, or by being found in an unhealthy state by the virtual machine health checks before
the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The
default value for this parameter is 20%.
:vartype max_unhealthy_instance_percent: int
:ivar max_unhealthy_upgraded_instance_percent: The maximum percentage of upgraded virtual
machine instances that can be found to be in an unhealthy state. This check will happen after
each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The
default value for this parameter is 20%.
:vartype max_unhealthy_upgraded_instance_percent: int
:ivar pause_time_between_batches: The wait time between completing the update for all virtual
machines in one batch and starting the next batch. The time duration should be specified in ISO
8601 format. The default value is 0 seconds (PT0S).
:vartype pause_time_between_batches: str
"""
_validation = {
"max_batch_instance_percent": {"maximum": 100, "minimum": 5},
"max_unhealthy_instance_percent": {"maximum": 100, "minimum": 5},
"max_unhealthy_upgraded_instance_percent": {"maximum": 100, "minimum": 0},
}
_attribute_map = {
"max_batch_instance_percent": {"key": "maxBatchInstancePercent", "type": "int"},
"max_unhealthy_instance_percent": {"key": "maxUnhealthyInstancePercent", "type": "int"},
"max_unhealthy_upgraded_instance_percent": {"key": "maxUnhealthyUpgradedInstancePercent", "type": "int"},
"pause_time_between_batches": {"key": "pauseTimeBetweenBatches", "type": "str"},
}
def __init__(
self,
*,
max_batch_instance_percent: Optional[int] = None,
max_unhealthy_instance_percent: Optional[int] = None,
max_unhealthy_upgraded_instance_percent: Optional[int] = None,
pause_time_between_batches: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword max_batch_instance_percent: The maximum percent of total virtual machine instances
that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum,
unhealthy instances in previous or future batches can cause the percentage of instances in a
batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
:paramtype max_batch_instance_percent: int
:keyword max_unhealthy_instance_percent: The maximum percentage of the total virtual machine
instances in the scale set that can be simultaneously unhealthy, either as a result of being
upgraded, or by being found in an unhealthy state by the virtual machine health checks before
the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The
default value for this parameter is 20%.
:paramtype max_unhealthy_instance_percent: int
:keyword max_unhealthy_upgraded_instance_percent: The maximum percentage of upgraded virtual
machine instances that can be found to be in an unhealthy state. This check will happen after
each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The
default value for this parameter is 20%.
:paramtype max_unhealthy_upgraded_instance_percent: int
:keyword pause_time_between_batches: The wait time between completing the update for all
virtual machines in one batch and starting the next batch. The time duration should be
specified in ISO 8601 format. The default value is 0 seconds (PT0S).
:paramtype pause_time_between_batches: str
"""
super().__init__(**kwargs)
self.max_batch_instance_percent = max_batch_instance_percent
self.max_unhealthy_instance_percent = max_unhealthy_instance_percent
self.max_unhealthy_upgraded_instance_percent = max_unhealthy_upgraded_instance_percent
self.pause_time_between_batches = pause_time_between_batches
[docs]class RollingUpgradeProgressInfo(_serialization.Model):
"""Information about the number of virtual machine instances in each upgrade state.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar successful_instance_count: The number of instances that have been successfully upgraded.
:vartype successful_instance_count: int
:ivar failed_instance_count: The number of instances that have failed to be upgraded
successfully.
:vartype failed_instance_count: int
:ivar in_progress_instance_count: The number of instances that are currently being upgraded.
:vartype in_progress_instance_count: int
:ivar pending_instance_count: The number of instances that have not yet begun to be upgraded.
:vartype pending_instance_count: int
"""
_validation = {
"successful_instance_count": {"readonly": True},
"failed_instance_count": {"readonly": True},
"in_progress_instance_count": {"readonly": True},
"pending_instance_count": {"readonly": True},
}
_attribute_map = {
"successful_instance_count": {"key": "successfulInstanceCount", "type": "int"},
"failed_instance_count": {"key": "failedInstanceCount", "type": "int"},
"in_progress_instance_count": {"key": "inProgressInstanceCount", "type": "int"},
"pending_instance_count": {"key": "pendingInstanceCount", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.successful_instance_count = None
self.failed_instance_count = None
self.in_progress_instance_count = None
self.pending_instance_count = None
[docs]class RollingUpgradeRunningStatus(_serialization.Model):
"""Information about the current running state of the overall upgrade.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: Code indicating the current status of the upgrade. Known values are:
"RollingForward", "Cancelled", "Completed", and "Faulted".
:vartype code: str or ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradeStatusCode
:ivar start_time: Start time of the upgrade.
:vartype start_time: ~datetime.datetime
:ivar last_action: The last action performed on the rolling upgrade. Known values are: "Start"
and "Cancel".
:vartype last_action: str or ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradeActionType
:ivar last_action_time: Last action time of the upgrade.
:vartype last_action_time: ~datetime.datetime
"""
_validation = {
"code": {"readonly": True},
"start_time": {"readonly": True},
"last_action": {"readonly": True},
"last_action_time": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"start_time": {"key": "startTime", "type": "iso-8601"},
"last_action": {"key": "lastAction", "type": "str"},
"last_action_time": {"key": "lastActionTime", "type": "iso-8601"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.code = None
self.start_time = None
self.last_action = None
self.last_action_time = None
[docs]class RollingUpgradeStatusInfo(Resource):
"""The status of the latest virtual machine scale set rolling upgrade.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar policy: The rolling upgrade policies applied for this upgrade.
:vartype policy: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradePolicy
:ivar running_status: Information about the current running state of the overall upgrade.
:vartype running_status: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradeRunningStatus
:ivar progress: Information about the number of virtual machine instances in each upgrade
state.
:vartype progress: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradeProgressInfo
:ivar error: Error details for this upgrade, if there are any.
:vartype error: ~azure.mgmt.compute.v2019_03_01.models.ApiError
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"policy": {"readonly": True},
"running_status": {"readonly": True},
"progress": {"readonly": True},
"error": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"policy": {"key": "properties.policy", "type": "RollingUpgradePolicy"},
"running_status": {"key": "properties.runningStatus", "type": "RollingUpgradeRunningStatus"},
"progress": {"key": "properties.progress", "type": "RollingUpgradeProgressInfo"},
"error": {"key": "properties.error", "type": "ApiError"},
}
def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(location=location, tags=tags, **kwargs)
self.policy = None
self.running_status = None
self.progress = None
self.error = None
[docs]class RunCommandDocumentBase(_serialization.Model):
"""Describes the properties of a Run Command metadata.
All required parameters must be populated in order to send to Azure.
:ivar schema: The VM run command schema. Required.
:vartype schema: str
:ivar id: The VM run command id. Required.
:vartype id: str
:ivar os_type: The Operating System type. Required. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar label: The VM run command label. Required.
:vartype label: str
:ivar description: The VM run command description. Required.
:vartype description: str
"""
_validation = {
"schema": {"required": True},
"id": {"required": True},
"os_type": {"required": True},
"label": {"required": True},
"description": {"required": True},
}
_attribute_map = {
"schema": {"key": "$schema", "type": "str"},
"id": {"key": "id", "type": "str"},
"os_type": {"key": "osType", "type": "str"},
"label": {"key": "label", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(
self,
*,
schema: str,
id: str, # pylint: disable=redefined-builtin
os_type: Union[str, "_models.OperatingSystemTypes"],
label: str,
description: str,
**kwargs: Any
) -> None:
"""
:keyword schema: The VM run command schema. Required.
:paramtype schema: str
:keyword id: The VM run command id. Required.
:paramtype id: str
:keyword os_type: The Operating System type. Required. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword label: The VM run command label. Required.
:paramtype label: str
:keyword description: The VM run command description. Required.
:paramtype description: str
"""
super().__init__(**kwargs)
self.schema = schema
self.id = id
self.os_type = os_type
self.label = label
self.description = description
[docs]class RunCommandDocument(RunCommandDocumentBase):
"""Describes the properties of a Run Command.
All required parameters must be populated in order to send to Azure.
:ivar schema: The VM run command schema. Required.
:vartype schema: str
:ivar id: The VM run command id. Required.
:vartype id: str
:ivar os_type: The Operating System type. Required. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar label: The VM run command label. Required.
:vartype label: str
:ivar description: The VM run command description. Required.
:vartype description: str
:ivar script: The script to be executed. Required.
:vartype script: list[str]
:ivar parameters: The parameters used by the script.
:vartype parameters: list[~azure.mgmt.compute.v2019_03_01.models.RunCommandParameterDefinition]
"""
_validation = {
"schema": {"required": True},
"id": {"required": True},
"os_type": {"required": True},
"label": {"required": True},
"description": {"required": True},
"script": {"required": True},
}
_attribute_map = {
"schema": {"key": "$schema", "type": "str"},
"id": {"key": "id", "type": "str"},
"os_type": {"key": "osType", "type": "str"},
"label": {"key": "label", "type": "str"},
"description": {"key": "description", "type": "str"},
"script": {"key": "script", "type": "[str]"},
"parameters": {"key": "parameters", "type": "[RunCommandParameterDefinition]"},
}
def __init__(
self,
*,
schema: str,
id: str, # pylint: disable=redefined-builtin
os_type: Union[str, "_models.OperatingSystemTypes"],
label: str,
description: str,
script: List[str],
parameters: Optional[List["_models.RunCommandParameterDefinition"]] = None,
**kwargs: Any
) -> None:
"""
:keyword schema: The VM run command schema. Required.
:paramtype schema: str
:keyword id: The VM run command id. Required.
:paramtype id: str
:keyword os_type: The Operating System type. Required. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword label: The VM run command label. Required.
:paramtype label: str
:keyword description: The VM run command description. Required.
:paramtype description: str
:keyword script: The script to be executed. Required.
:paramtype script: list[str]
:keyword parameters: The parameters used by the script.
:paramtype parameters:
list[~azure.mgmt.compute.v2019_03_01.models.RunCommandParameterDefinition]
"""
super().__init__(schema=schema, id=id, os_type=os_type, label=label, description=description, **kwargs)
self.script = script
self.parameters = parameters
[docs]class RunCommandListResult(_serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of virtual machine run commands. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.RunCommandDocumentBase]
:ivar next_link: The uri to fetch the next page of run commands. Call ListNext() with this to
fetch the next page of run commands.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[RunCommandDocumentBase]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.RunCommandDocumentBase"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of virtual machine run commands. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.RunCommandDocumentBase]
:keyword next_link: The uri to fetch the next page of run commands. Call ListNext() with this
to fetch the next page of run commands.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class RunCommandParameterDefinition(_serialization.Model):
"""Describes the properties of a run command parameter.
All required parameters must be populated in order to send to Azure.
:ivar name: The run command parameter name. Required.
:vartype name: str
:ivar type: The run command parameter type. Required.
:vartype type: str
:ivar default_value: The run command parameter default value.
:vartype default_value: str
:ivar required: The run command parameter required.
:vartype required: bool
"""
_validation = {
"name": {"required": True},
"type": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"default_value": {"key": "defaultValue", "type": "str"},
"required": {"key": "required", "type": "bool"},
}
def __init__(
self, *, name: str, type: str, default_value: Optional[str] = None, required: bool = False, **kwargs: Any
) -> None:
"""
:keyword name: The run command parameter name. Required.
:paramtype name: str
:keyword type: The run command parameter type. Required.
:paramtype type: str
:keyword default_value: The run command parameter default value.
:paramtype default_value: str
:keyword required: The run command parameter required.
:paramtype required: bool
"""
super().__init__(**kwargs)
self.name = name
self.type = type
self.default_value = default_value
self.required = required
[docs]class RunCommandResult(_serialization.Model):
"""RunCommandResult.
:ivar value: Run command operation response.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_attribute_map = {
"value": {"key": "value", "type": "[InstanceViewStatus]"},
}
def __init__(self, *, value: Optional[List["_models.InstanceViewStatus"]] = None, **kwargs: Any) -> None:
"""
:keyword value: Run command operation response.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.value = value
[docs]class ScaleInPolicy(_serialization.Model):
"""Describes a scale-in policy for a virtual machine scale set.
:ivar rules: The rules to be followed when scaling-in a virtual machine scale set.
:code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` **Default** When a
virtual machine scale set is scaled in, the scale set will first be balanced across zones if it
is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within
each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not
protected from scale-in. :code:`<br>`:code:`<br>` **OldestVM** When a virtual machine scale set
is being scaled-in, the oldest virtual machines that are not protected from scale-in will be
chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced
across zones. Within each zone, the oldest virtual machines that are not protected will be
chosen for removal. :code:`<br>`:code:`<br>` **NewestVM** When a virtual machine scale set is
being scaled-in, the newest virtual machines that are not protected from scale-in will be
chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced
across zones. Within each zone, the newest virtual machines that are not protected will be
chosen for removal. :code:`<br>`:code:`<br>`.
:vartype rules: list[str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetScaleInRules]
"""
_attribute_map = {
"rules": {"key": "rules", "type": "[str]"},
}
def __init__(
self, *, rules: Optional[List[Union[str, "_models.VirtualMachineScaleSetScaleInRules"]]] = None, **kwargs: Any
) -> None:
"""
:keyword rules: The rules to be followed when scaling-in a virtual machine scale set.
:code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` **Default** When a
virtual machine scale set is scaled in, the scale set will first be balanced across zones if it
is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within
each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not
protected from scale-in. :code:`<br>`:code:`<br>` **OldestVM** When a virtual machine scale set
is being scaled-in, the oldest virtual machines that are not protected from scale-in will be
chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced
across zones. Within each zone, the oldest virtual machines that are not protected will be
chosen for removal. :code:`<br>`:code:`<br>` **NewestVM** When a virtual machine scale set is
being scaled-in, the newest virtual machines that are not protected from scale-in will be
chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced
across zones. Within each zone, the newest virtual machines that are not protected will be
chosen for removal. :code:`<br>`:code:`<br>`.
:paramtype rules: list[str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetScaleInRules]
"""
super().__init__(**kwargs)
self.rules = rules
[docs]class ScheduledEventsProfile(_serialization.Model):
"""ScheduledEventsProfile.
:ivar terminate_notification_profile: Specifies Terminate Scheduled Event related
configurations.
:vartype terminate_notification_profile:
~azure.mgmt.compute.v2019_03_01.models.TerminateNotificationProfile
"""
_attribute_map = {
"terminate_notification_profile": {
"key": "terminateNotificationProfile",
"type": "TerminateNotificationProfile",
},
}
def __init__(
self, *, terminate_notification_profile: Optional["_models.TerminateNotificationProfile"] = None, **kwargs: Any
) -> None:
"""
:keyword terminate_notification_profile: Specifies Terminate Scheduled Event related
configurations.
:paramtype terminate_notification_profile:
~azure.mgmt.compute.v2019_03_01.models.TerminateNotificationProfile
"""
super().__init__(**kwargs)
self.terminate_notification_profile = terminate_notification_profile
[docs]class Sku(_serialization.Model):
"""Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the
hardware the scale set is currently on, you need to deallocate the VMs in the scale set before
you modify the SKU name.
:ivar name: The sku name.
:vartype name: str
:ivar tier: Specifies the tier of virtual machines in a scale set.:code:`<br />`:code:`<br />`
Possible Values::code:`<br />`:code:`<br />` **Standard**\ :code:`<br />`:code:`<br />`
**Basic**.
:vartype tier: str
:ivar capacity: Specifies the number of virtual machines in the scale set.
:vartype capacity: int
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"tier": {"key": "tier", "type": "str"},
"capacity": {"key": "capacity", "type": "int"},
}
def __init__(
self, *, name: Optional[str] = None, tier: Optional[str] = None, capacity: Optional[int] = None, **kwargs: Any
) -> None:
"""
:keyword name: The sku name.
:paramtype name: str
:keyword tier: Specifies the tier of virtual machines in a scale set.:code:`<br />`:code:`<br
/>` Possible Values::code:`<br />`:code:`<br />` **Standard**\ :code:`<br />`:code:`<br />`
**Basic**.
:paramtype tier: str
:keyword capacity: Specifies the number of virtual machines in the scale set.
:paramtype capacity: int
"""
super().__init__(**kwargs)
self.name = name
self.tier = tier
self.capacity = capacity
[docs]class Snapshot(Resource): # pylint: disable=too-many-instance-attributes
"""Snapshot resource.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar managed_by: Unused. Always Null.
:vartype managed_by: str
:ivar sku: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.SnapshotSku
:ivar time_created: The time when the disk was created.
:vartype time_created: ~datetime.datetime
:ivar os_type: The Operating System type. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar hyper_v_generation: The hypervisor generation of the Virtual Machine. Applicable to OS
disks only. Known values are: "V1" and "V2".
:vartype hyper_v_generation: str or ~azure.mgmt.compute.v2019_03_01.models.HyperVGeneration
:ivar creation_data: Disk source information. CreationData information cannot be changed after
the disk has been created.
:vartype creation_data: ~azure.mgmt.compute.v2019_03_01.models.CreationData
:ivar disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:vartype disk_size_gb: int
:ivar disk_size_bytes: The size of the disk in bytes. This field is read only.
:vartype disk_size_bytes: int
:ivar unique_id: Unique Guid identifying the resource.
:vartype unique_id: str
:ivar encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:vartype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:ivar provisioning_state: The disk provisioning state.
:vartype provisioning_state: str
:ivar incremental: Whether a snapshot is incremental. Incremental snapshots on the same disk
occupy less space than full snapshots and can be diffed.
:vartype incremental: bool
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"managed_by": {"readonly": True},
"time_created": {"readonly": True},
"disk_size_bytes": {"readonly": True},
"unique_id": {"readonly": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"managed_by": {"key": "managedBy", "type": "str"},
"sku": {"key": "sku", "type": "SnapshotSku"},
"time_created": {"key": "properties.timeCreated", "type": "iso-8601"},
"os_type": {"key": "properties.osType", "type": "str"},
"hyper_v_generation": {"key": "properties.hyperVGeneration", "type": "str"},
"creation_data": {"key": "properties.creationData", "type": "CreationData"},
"disk_size_gb": {"key": "properties.diskSizeGB", "type": "int"},
"disk_size_bytes": {"key": "properties.diskSizeBytes", "type": "int"},
"unique_id": {"key": "properties.uniqueId", "type": "str"},
"encryption_settings_collection": {
"key": "properties.encryptionSettingsCollection",
"type": "EncryptionSettingsCollection",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"incremental": {"key": "properties.incremental", "type": "bool"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.SnapshotSku"] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGeneration"]] = None,
creation_data: Optional["_models.CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings_collection: Optional["_models.EncryptionSettingsCollection"] = None,
incremental: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.SnapshotSku
:keyword os_type: The Operating System type. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword hyper_v_generation: The hypervisor generation of the Virtual Machine. Applicable to OS
disks only. Known values are: "V1" and "V2".
:paramtype hyper_v_generation: str or ~azure.mgmt.compute.v2019_03_01.models.HyperVGeneration
:keyword creation_data: Disk source information. CreationData information cannot be changed
after the disk has been created.
:paramtype creation_data: ~azure.mgmt.compute.v2019_03_01.models.CreationData
:keyword disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:paramtype disk_size_gb: int
:keyword encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:paramtype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
:keyword incremental: Whether a snapshot is incremental. Incremental snapshots on the same disk
occupy less space than full snapshots and can be diffed.
:paramtype incremental: bool
"""
super().__init__(location=location, tags=tags, **kwargs)
self.managed_by = None
self.sku = sku
self.time_created = None
self.os_type = os_type
self.hyper_v_generation = hyper_v_generation
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.disk_size_bytes = None
self.unique_id = None
self.encryption_settings_collection = encryption_settings_collection
self.provisioning_state = None
self.incremental = incremental
[docs]class SnapshotList(_serialization.Model):
"""The List Snapshots operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: A list of snapshots. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.Snapshot]
:ivar next_link: The uri to fetch the next page of snapshots. Call ListNext() with this to
fetch the next page of snapshots.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Snapshot]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: List["_models.Snapshot"], next_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: A list of snapshots. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.Snapshot]
:keyword next_link: The uri to fetch the next page of snapshots. Call ListNext() with this to
fetch the next page of snapshots.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class SnapshotSku(_serialization.Model):
"""The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: The sku name. Known values are: "Standard_LRS", "Premium_LRS", and "Standard_ZRS".
:vartype name: str or ~azure.mgmt.compute.v2019_03_01.models.SnapshotStorageAccountTypes
:ivar tier: The sku tier.
:vartype tier: str
"""
_validation = {
"tier": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"tier": {"key": "tier", "type": "str"},
}
def __init__(
self, *, name: Optional[Union[str, "_models.SnapshotStorageAccountTypes"]] = None, **kwargs: Any
) -> None:
"""
:keyword name: The sku name. Known values are: "Standard_LRS", "Premium_LRS", and
"Standard_ZRS".
:paramtype name: str or ~azure.mgmt.compute.v2019_03_01.models.SnapshotStorageAccountTypes
"""
super().__init__(**kwargs)
self.name = name
self.tier = None
[docs]class SnapshotUpdate(_serialization.Model):
"""Snapshot update resource.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.SnapshotSku
:ivar os_type: the Operating System type. Known values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:vartype disk_size_gb: int
:ivar encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:vartype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "SnapshotSku"},
"os_type": {"key": "properties.osType", "type": "str"},
"disk_size_gb": {"key": "properties.diskSizeGB", "type": "int"},
"encryption_settings_collection": {
"key": "properties.encryptionSettingsCollection",
"type": "EncryptionSettingsCollection",
},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.SnapshotSku"] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
disk_size_gb: Optional[int] = None,
encryption_settings_collection: Optional["_models.EncryptionSettingsCollection"] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.SnapshotSku
:keyword os_type: the Operating System type. Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword disk_size_gb: If creationData.createOption is Empty, this field is mandatory and it
indicates the size of the disk to create. If this field is present for updates or creation with
other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a
running VM, and can only increase the disk's size.
:paramtype disk_size_gb: int
:keyword encryption_settings_collection: Encryption settings collection used be Azure Disk
Encryption, can contain multiple encryption settings per disk or snapshot.
:paramtype encryption_settings_collection:
~azure.mgmt.compute.v2019_03_01.models.EncryptionSettingsCollection
"""
super().__init__(**kwargs)
self.tags = tags
self.sku = sku
self.os_type = os_type
self.disk_size_gb = disk_size_gb
self.encryption_settings_collection = encryption_settings_collection
[docs]class SourceVault(_serialization.Model):
"""The vault id is an Azure Resource Manager Resource id in the form
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}.
:ivar id: Resource Id.
:vartype id: str
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, *, id: Optional[str] = None, **kwargs: Any) -> None: # pylint: disable=redefined-builtin
"""
:keyword id: Resource Id.
:paramtype id: str
"""
super().__init__(**kwargs)
self.id = id
[docs]class SshConfiguration(_serialization.Model):
"""SSH configuration for Linux based VMs running on Azure.
:ivar public_keys: The list of SSH public keys used to authenticate with linux based VMs.
:vartype public_keys: list[~azure.mgmt.compute.v2019_03_01.models.SshPublicKey]
"""
_attribute_map = {
"public_keys": {"key": "publicKeys", "type": "[SshPublicKey]"},
}
def __init__(self, *, public_keys: Optional[List["_models.SshPublicKey"]] = None, **kwargs: Any) -> None:
"""
:keyword public_keys: The list of SSH public keys used to authenticate with linux based VMs.
:paramtype public_keys: list[~azure.mgmt.compute.v2019_03_01.models.SshPublicKey]
"""
super().__init__(**kwargs)
self.public_keys = public_keys
[docs]class SshPublicKey(_serialization.Model):
"""Contains information about SSH certificate public key and the path on the Linux VM where the
public key is placed.
:ivar path: Specifies the full path on the created VM where ssh public key is stored. If the
file already exists, the specified key is appended to the file. Example:
/home/user/.ssh/authorized_keys.
:vartype path: str
:ivar key_data: SSH public key certificate used to authenticate with the VM through ssh. The
key needs to be at least 2048-bit and in ssh-rsa format. :code:`<br>`:code:`<br>` For creating
ssh keys, see `Create SSH keys on Linux and Mac for Linux VMs in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype key_data: str
"""
_attribute_map = {
"path": {"key": "path", "type": "str"},
"key_data": {"key": "keyData", "type": "str"},
}
def __init__(self, *, path: Optional[str] = None, key_data: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword path: Specifies the full path on the created VM where ssh public key is stored. If the
file already exists, the specified key is appended to the file. Example:
/home/user/.ssh/authorized_keys.
:paramtype path: str
:keyword key_data: SSH public key certificate used to authenticate with the VM through ssh. The
key needs to be at least 2048-bit and in ssh-rsa format. :code:`<br>`:code:`<br>` For creating
ssh keys, see `Create SSH keys on Linux and Mac for Linux VMs in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype key_data: str
"""
super().__init__(**kwargs)
self.path = path
self.key_data = key_data
[docs]class StorageProfile(_serialization.Model):
"""Specifies the storage settings for the virtual machine disks.
:ivar image_reference: Specifies information about the image to use. You can specify
information about platform images, marketplace images, or virtual machine images. This element
is required when you want to use a platform image, marketplace image, or virtual machine image,
but is not used in other creation operations.
:vartype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:ivar os_disk: Specifies information about the operating system disk used by the virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype os_disk: ~azure.mgmt.compute.v2019_03_01.models.OSDisk
:ivar data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype data_disks: list[~azure.mgmt.compute.v2019_03_01.models.DataDisk]
"""
_attribute_map = {
"image_reference": {"key": "imageReference", "type": "ImageReference"},
"os_disk": {"key": "osDisk", "type": "OSDisk"},
"data_disks": {"key": "dataDisks", "type": "[DataDisk]"},
}
def __init__(
self,
*,
image_reference: Optional["_models.ImageReference"] = None,
os_disk: Optional["_models.OSDisk"] = None,
data_disks: Optional[List["_models.DataDisk"]] = None,
**kwargs: Any
) -> None:
"""
:keyword image_reference: Specifies information about the image to use. You can specify
information about platform images, marketplace images, or virtual machine images. This element
is required when you want to use a platform image, marketplace image, or virtual machine image,
but is not used in other creation operations.
:paramtype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:keyword os_disk: Specifies information about the operating system disk used by the virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype os_disk: ~azure.mgmt.compute.v2019_03_01.models.OSDisk
:keyword data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype data_disks: list[~azure.mgmt.compute.v2019_03_01.models.DataDisk]
"""
super().__init__(**kwargs)
self.image_reference = image_reference
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class SubResourceReadOnly(_serialization.Model):
"""SubResourceReadOnly.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
"""
_validation = {
"id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
[docs]class TargetRegion(_serialization.Model):
"""Describes the target region information.
All required parameters must be populated in order to send to Azure.
:ivar name: The name of the region. Required.
:vartype name: str
:ivar regional_replica_count: The number of replicas of the Image Version to be created per
region. This property is updatable.
:vartype regional_replica_count: int
:ivar storage_account_type: Specifies the storage account type to be used to store the image.
This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:vartype storage_account_type: str or ~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"regional_replica_count": {"key": "regionalReplicaCount", "type": "int"},
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self,
*,
name: str,
regional_replica_count: Optional[int] = None,
storage_account_type: Optional[Union[str, "_models.StorageAccountType"]] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The name of the region. Required.
:paramtype name: str
:keyword regional_replica_count: The number of replicas of the Image Version to be created per
region. This property is updatable.
:paramtype regional_replica_count: int
:keyword storage_account_type: Specifies the storage account type to be used to store the
image. This property is not updatable. Known values are: "Standard_LRS" and "Standard_ZRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountType
"""
super().__init__(**kwargs)
self.name = name
self.regional_replica_count = regional_replica_count
self.storage_account_type = storage_account_type
[docs]class TerminateNotificationProfile(_serialization.Model):
"""TerminateNotificationProfile.
:ivar not_before_timeout: Configurable length of time a Virtual Machine being deleted will have
to potentially approve the Terminate Scheduled Event before the event is auto approved (timed
out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes
(PT5M).
:vartype not_before_timeout: str
:ivar enable: Specifies whether the Terminate Scheduled event is enabled or disabled.
:vartype enable: bool
"""
_attribute_map = {
"not_before_timeout": {"key": "notBeforeTimeout", "type": "str"},
"enable": {"key": "enable", "type": "bool"},
}
def __init__(
self, *, not_before_timeout: Optional[str] = None, enable: Optional[bool] = None, **kwargs: Any
) -> None:
"""
:keyword not_before_timeout: Configurable length of time a Virtual Machine being deleted will
have to potentially approve the Terminate Scheduled Event before the event is auto approved
(timed out). The configuration must be specified in ISO 8601 format, the default value is 5
minutes (PT5M).
:paramtype not_before_timeout: str
:keyword enable: Specifies whether the Terminate Scheduled event is enabled or disabled.
:paramtype enable: bool
"""
super().__init__(**kwargs)
self.not_before_timeout = not_before_timeout
self.enable = enable
[docs]class UpgradeOperationHistoricalStatusInfo(_serialization.Model):
"""Virtual Machine Scale Set OS Upgrade History operation response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar properties: Information about the properties of the upgrade operation.
:vartype properties:
~azure.mgmt.compute.v2019_03_01.models.UpgradeOperationHistoricalStatusInfoProperties
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location.
:vartype location: str
"""
_validation = {
"properties": {"readonly": True},
"type": {"readonly": True},
"location": {"readonly": True},
}
_attribute_map = {
"properties": {"key": "properties", "type": "UpgradeOperationHistoricalStatusInfoProperties"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.properties = None
self.type = None
self.location = None
[docs]class UpgradeOperationHistoricalStatusInfoProperties(_serialization.Model):
"""Describes each OS upgrade on the Virtual Machine Scale Set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar running_status: Information about the overall status of the upgrade operation.
:vartype running_status: ~azure.mgmt.compute.v2019_03_01.models.UpgradeOperationHistoryStatus
:ivar progress: Counts of the VMs in each state.
:vartype progress: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradeProgressInfo
:ivar error: Error Details for this upgrade if there are any.
:vartype error: ~azure.mgmt.compute.v2019_03_01.models.ApiError
:ivar started_by: Invoker of the Upgrade Operation. Known values are: "Unknown", "User", and
"Platform".
:vartype started_by: str or ~azure.mgmt.compute.v2019_03_01.models.UpgradeOperationInvoker
:ivar target_image_reference: Image Reference details.
:vartype target_image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:ivar rollback_info: Information about OS rollback if performed.
:vartype rollback_info: ~azure.mgmt.compute.v2019_03_01.models.RollbackStatusInfo
"""
_validation = {
"running_status": {"readonly": True},
"progress": {"readonly": True},
"error": {"readonly": True},
"started_by": {"readonly": True},
"target_image_reference": {"readonly": True},
"rollback_info": {"readonly": True},
}
_attribute_map = {
"running_status": {"key": "runningStatus", "type": "UpgradeOperationHistoryStatus"},
"progress": {"key": "progress", "type": "RollingUpgradeProgressInfo"},
"error": {"key": "error", "type": "ApiError"},
"started_by": {"key": "startedBy", "type": "str"},
"target_image_reference": {"key": "targetImageReference", "type": "ImageReference"},
"rollback_info": {"key": "rollbackInfo", "type": "RollbackStatusInfo"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.running_status = None
self.progress = None
self.error = None
self.started_by = None
self.target_image_reference = None
self.rollback_info = None
[docs]class UpgradeOperationHistoryStatus(_serialization.Model):
"""Information about the current running state of the overall upgrade.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: Code indicating the current status of the upgrade. Known values are:
"RollingForward", "Cancelled", "Completed", and "Faulted".
:vartype code: str or ~azure.mgmt.compute.v2019_03_01.models.UpgradeState
:ivar start_time: Start time of the upgrade.
:vartype start_time: ~datetime.datetime
:ivar end_time: End time of the upgrade.
:vartype end_time: ~datetime.datetime
"""
_validation = {
"code": {"readonly": True},
"start_time": {"readonly": True},
"end_time": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"start_time": {"key": "startTime", "type": "iso-8601"},
"end_time": {"key": "endTime", "type": "iso-8601"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.code = None
self.start_time = None
self.end_time = None
[docs]class UpgradePolicy(_serialization.Model):
"""Describes an upgrade policy - automatic, manual, or rolling.
:ivar mode: Specifies the mode of an upgrade to virtual machines in the scale set.:code:`<br
/>`:code:`<br />` Possible values are::code:`<br />`:code:`<br />` **Manual** - You control
the application of updates to virtual machines in the scale set. You do this by using the
manualUpgrade action.:code:`<br />`:code:`<br />` **Automatic** - All virtual machines in the
scale set are automatically updated at the same time. Known values are: "Automatic", "Manual",
and "Rolling".
:vartype mode: str or ~azure.mgmt.compute.v2019_03_01.models.UpgradeMode
:ivar rolling_upgrade_policy: The configuration parameters used while performing a rolling
upgrade.
:vartype rolling_upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradePolicy
:ivar automatic_os_upgrade_policy: Configuration parameters used for performing automatic OS
Upgrade.
:vartype automatic_os_upgrade_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticOSUpgradePolicy
"""
_attribute_map = {
"mode": {"key": "mode", "type": "str"},
"rolling_upgrade_policy": {"key": "rollingUpgradePolicy", "type": "RollingUpgradePolicy"},
"automatic_os_upgrade_policy": {"key": "automaticOSUpgradePolicy", "type": "AutomaticOSUpgradePolicy"},
}
def __init__(
self,
*,
mode: Optional[Union[str, "_models.UpgradeMode"]] = None,
rolling_upgrade_policy: Optional["_models.RollingUpgradePolicy"] = None,
automatic_os_upgrade_policy: Optional["_models.AutomaticOSUpgradePolicy"] = None,
**kwargs: Any
) -> None:
"""
:keyword mode: Specifies the mode of an upgrade to virtual machines in the scale set.:code:`<br
/>`:code:`<br />` Possible values are::code:`<br />`:code:`<br />` **Manual** - You control
the application of updates to virtual machines in the scale set. You do this by using the
manualUpgrade action.:code:`<br />`:code:`<br />` **Automatic** - All virtual machines in the
scale set are automatically updated at the same time. Known values are: "Automatic", "Manual",
and "Rolling".
:paramtype mode: str or ~azure.mgmt.compute.v2019_03_01.models.UpgradeMode
:keyword rolling_upgrade_policy: The configuration parameters used while performing a rolling
upgrade.
:paramtype rolling_upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.RollingUpgradePolicy
:keyword automatic_os_upgrade_policy: Configuration parameters used for performing automatic OS
Upgrade.
:paramtype automatic_os_upgrade_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticOSUpgradePolicy
"""
super().__init__(**kwargs)
self.mode = mode
self.rolling_upgrade_policy = rolling_upgrade_policy
self.automatic_os_upgrade_policy = automatic_os_upgrade_policy
[docs]class Usage(_serialization.Model):
"""Describes Compute Resource Usage.
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.
:ivar unit: An enum describing the unit of usage measurement. Required. Default value is
"Count".
:vartype unit: str
:ivar current_value: The current usage of the resource. Required.
:vartype current_value: int
:ivar limit: The maximum permitted usage of the resource. Required.
:vartype limit: int
:ivar name: The name of the type of usage. Required.
:vartype name: ~azure.mgmt.compute.v2019_03_01.models.UsageName
"""
_validation = {
"unit": {"required": True, "constant": True},
"current_value": {"required": True},
"limit": {"required": True},
"name": {"required": True},
}
_attribute_map = {
"unit": {"key": "unit", "type": "str"},
"current_value": {"key": "currentValue", "type": "int"},
"limit": {"key": "limit", "type": "int"},
"name": {"key": "name", "type": "UsageName"},
}
unit = "Count"
def __init__(self, *, current_value: int, limit: int, name: "_models.UsageName", **kwargs: Any) -> None:
"""
:keyword current_value: The current usage of the resource. Required.
:paramtype current_value: int
:keyword limit: The maximum permitted usage of the resource. Required.
:paramtype limit: int
:keyword name: The name of the type of usage. Required.
:paramtype name: ~azure.mgmt.compute.v2019_03_01.models.UsageName
"""
super().__init__(**kwargs)
self.current_value = current_value
self.limit = limit
self.name = name
[docs]class UsageName(_serialization.Model):
"""The Usage Names.
:ivar value: The name of the resource.
:vartype value: str
:ivar localized_value: The localized name of the resource.
:vartype localized_value: str
"""
_attribute_map = {
"value": {"key": "value", "type": "str"},
"localized_value": {"key": "localizedValue", "type": "str"},
}
def __init__(self, *, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword value: The name of the resource.
:paramtype value: str
:keyword localized_value: The localized name of the resource.
:paramtype localized_value: str
"""
super().__init__(**kwargs)
self.value = value
self.localized_value = localized_value
[docs]class UserArtifactManage(_serialization.Model):
"""UserArtifactManage.
All required parameters must be populated in order to send to Azure.
:ivar install: Required. The path and arguments to install the gallery application. This is
limited to 4096 characters. Required.
:vartype install: str
:ivar remove: Required. The path and arguments to remove the gallery application. This is
limited to 4096 characters. Required.
:vartype remove: str
:ivar update: Optional. The path and arguments to update the gallery application. If not
present, then update operation will invoke remove command on the previous version and install
command on the current version of the gallery application. This is limited to 4096 characters.
:vartype update: str
"""
_validation = {
"install": {"required": True},
"remove": {"required": True},
}
_attribute_map = {
"install": {"key": "install", "type": "str"},
"remove": {"key": "remove", "type": "str"},
"update": {"key": "update", "type": "str"},
}
def __init__(self, *, install: str, remove: str, update: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword install: Required. The path and arguments to install the gallery application. This is
limited to 4096 characters. Required.
:paramtype install: str
:keyword remove: Required. The path and arguments to remove the gallery application. This is
limited to 4096 characters. Required.
:paramtype remove: str
:keyword update: Optional. The path and arguments to update the gallery application. If not
present, then update operation will invoke remove command on the previous version and install
command on the current version of the gallery application. This is limited to 4096 characters.
:paramtype update: str
"""
super().__init__(**kwargs)
self.install = install
self.remove = remove
self.update = update
[docs]class UserArtifactSource(_serialization.Model):
"""The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
:ivar media_link: Required. The mediaLink of the artifact, must be a readable storage page
blob. Required.
:vartype media_link: str
:ivar default_configuration_link: Optional. The defaultConfigurationLink of the artifact, must
be a readable storage page blob.
:vartype default_configuration_link: str
"""
_validation = {
"media_link": {"required": True},
}
_attribute_map = {
"media_link": {"key": "mediaLink", "type": "str"},
"default_configuration_link": {"key": "defaultConfigurationLink", "type": "str"},
}
def __init__(self, *, media_link: str, default_configuration_link: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword media_link: Required. The mediaLink of the artifact, must be a readable storage page
blob. Required.
:paramtype media_link: str
:keyword default_configuration_link: Optional. The defaultConfigurationLink of the artifact,
must be a readable storage page blob.
:paramtype default_configuration_link: str
"""
super().__init__(**kwargs)
self.media_link = media_link
self.default_configuration_link = default_configuration_link
[docs]class UserAssignedIdentitiesValue(_serialization.Model):
"""UserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of user assigned identity.
:vartype principal_id: str
:ivar client_id: The client id of user assigned identity.
:vartype client_id: str
"""
_validation = {
"principal_id": {"readonly": True},
"client_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"client_id": {"key": "clientId", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.principal_id = None
self.client_id = None
[docs]class VaultCertificate(_serialization.Model):
"""Describes a single certificate reference in a Key Vault, and where the certificate should
reside on the VM.
:ivar certificate_url: This is the URL of a certificate that has been uploaded to Key Vault as
a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>`
"data":":code:`<Base64-encoded-certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>`
"password":":code:`<pfx-file-password>`":code:`<br>`}.
:vartype certificate_url: str
:ivar certificate_store: For Windows VMs, specifies the certificate store on the Virtual
Machine to which the certificate should be added. The specified certificate store is implicitly
in the LocalMachine account. :code:`<br>`:code:`<br>`For Linux VMs, the certificate file is
placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt
for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of
these files are .pem formatted.
:vartype certificate_store: str
"""
_attribute_map = {
"certificate_url": {"key": "certificateUrl", "type": "str"},
"certificate_store": {"key": "certificateStore", "type": "str"},
}
def __init__(
self, *, certificate_url: Optional[str] = None, certificate_store: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword certificate_url: This is the URL of a certificate that has been uploaded to Key Vault
as a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>`
"data":":code:`<Base64-encoded-certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>`
"password":":code:`<pfx-file-password>`":code:`<br>`}.
:paramtype certificate_url: str
:keyword certificate_store: For Windows VMs, specifies the certificate store on the Virtual
Machine to which the certificate should be added. The specified certificate store is implicitly
in the LocalMachine account. :code:`<br>`:code:`<br>`For Linux VMs, the certificate file is
placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt
for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of
these files are .pem formatted.
:paramtype certificate_store: str
"""
super().__init__(**kwargs)
self.certificate_url = certificate_url
self.certificate_store = certificate_store
[docs]class VaultSecretGroup(_serialization.Model):
"""Describes a set of certificates which are all in the same Key Vault.
:ivar source_vault: The relative URL of the Key Vault containing all of the certificates in
VaultCertificates.
:vartype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar vault_certificates: The list of key vault references in SourceVault which contain
certificates.
:vartype vault_certificates: list[~azure.mgmt.compute.v2019_03_01.models.VaultCertificate]
"""
_attribute_map = {
"source_vault": {"key": "sourceVault", "type": "SubResource"},
"vault_certificates": {"key": "vaultCertificates", "type": "[VaultCertificate]"},
}
def __init__(
self,
*,
source_vault: Optional["_models.SubResource"] = None,
vault_certificates: Optional[List["_models.VaultCertificate"]] = None,
**kwargs: Any
) -> None:
"""
:keyword source_vault: The relative URL of the Key Vault containing all of the certificates in
VaultCertificates.
:paramtype source_vault: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword vault_certificates: The list of key vault references in SourceVault which contain
certificates.
:paramtype vault_certificates: list[~azure.mgmt.compute.v2019_03_01.models.VaultCertificate]
"""
super().__init__(**kwargs)
self.source_vault = source_vault
self.vault_certificates = vault_certificates
[docs]class VirtualHardDisk(_serialization.Model):
"""Describes the uri of a disk.
:ivar uri: Specifies the virtual hard disk's uri.
:vartype uri: str
"""
_attribute_map = {
"uri": {"key": "uri", "type": "str"},
}
def __init__(self, *, uri: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword uri: Specifies the virtual hard disk's uri.
:paramtype uri: str
"""
super().__init__(**kwargs)
self.uri = uri
[docs]class VirtualMachine(Resource): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:ivar resources: The virtual machine child extension resources.
:vartype resources: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
:ivar identity: The identity of the virtual machine, if configured.
:vartype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineIdentity
:ivar zones: The virtual machine zones.
:vartype zones: list[str]
:ivar hardware_profile: Specifies the hardware settings for the virtual machine.
:vartype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:ivar additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine.
:vartype additional_capabilities: ~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:ivar os_profile: Specifies the operating system settings for the virtual machine.
:vartype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:ivar network_profile: Specifies the network interfaces of the virtual machine.
:vartype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:ivar diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:vartype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:ivar availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set. :code:`<br>`:code:`<br>`This
property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
:vartype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar virtual_machine_scale_set: Specifies information about the virtual machine scale set that
the virtual machine should be assigned to. Virtual machines specified in the same virtual
machine scale set are allocated to different nodes to maximize availability. Currently, a VM
can only be added to virtual machine scale set at creation time. An existing VM cannot be added
to a virtual machine scale set. :code:`<br>`:code:`<br>`This property cannot exist along with a
non-null properties.availabilitySet reference. :code:`<br>`:code:`<br>`Minimum api‐version:
2019‐03‐01.
:vartype virtual_machine_scale_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the virtual machine should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar priority: Specifies the priority for the virtual machine. :code:`<br>`:code:`<br>`Minimum
api-version: 2019-03-01. Known values are: "Regular", "Low", and "Spot".
:vartype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:ivar eviction_policy: Specifies the eviction policy for the Azure Spot virtual machine. Only
supported value is 'Deallocate'. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01. Known
values are: "Deallocate" and "Delete".
:vartype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:ivar billing_profile: Specifies the billing related details of a Azure Spot virtual machine.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:vartype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:ivar host: Specifies information about the dedicated host that the virtual machine resides in.
:code:`<br>`:code:`<br>`Minimum api-version: 2018-10-01.
:vartype host: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The virtual machine instance view.
:vartype instance_view: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineInstanceView
:ivar license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype license_type: str
:ivar vm_id: Specifies the VM unique ID which is a 128-bits identifier that is encoded and
stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
:vartype vm_id: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"resources": {"readonly": True},
"provisioning_state": {"readonly": True},
"instance_view": {"readonly": True},
"vm_id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"plan": {"key": "plan", "type": "Plan"},
"resources": {"key": "resources", "type": "[VirtualMachineExtension]"},
"identity": {"key": "identity", "type": "VirtualMachineIdentity"},
"zones": {"key": "zones", "type": "[str]"},
"hardware_profile": {"key": "properties.hardwareProfile", "type": "HardwareProfile"},
"storage_profile": {"key": "properties.storageProfile", "type": "StorageProfile"},
"additional_capabilities": {"key": "properties.additionalCapabilities", "type": "AdditionalCapabilities"},
"os_profile": {"key": "properties.osProfile", "type": "OSProfile"},
"network_profile": {"key": "properties.networkProfile", "type": "NetworkProfile"},
"diagnostics_profile": {"key": "properties.diagnosticsProfile", "type": "DiagnosticsProfile"},
"availability_set": {"key": "properties.availabilitySet", "type": "SubResource"},
"virtual_machine_scale_set": {"key": "properties.virtualMachineScaleSet", "type": "SubResource"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
"priority": {"key": "properties.priority", "type": "str"},
"eviction_policy": {"key": "properties.evictionPolicy", "type": "str"},
"billing_profile": {"key": "properties.billingProfile", "type": "BillingProfile"},
"host": {"key": "properties.host", "type": "SubResource"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "VirtualMachineInstanceView"},
"license_type": {"key": "properties.licenseType", "type": "str"},
"vm_id": {"key": "properties.vmId", "type": "str"},
}
def __init__( # pylint: disable=too-many-locals
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
plan: Optional["_models.Plan"] = None,
identity: Optional["_models.VirtualMachineIdentity"] = None,
zones: Optional[List[str]] = None,
hardware_profile: Optional["_models.HardwareProfile"] = None,
storage_profile: Optional["_models.StorageProfile"] = None,
additional_capabilities: Optional["_models.AdditionalCapabilities"] = None,
os_profile: Optional["_models.OSProfile"] = None,
network_profile: Optional["_models.NetworkProfile"] = None,
diagnostics_profile: Optional["_models.DiagnosticsProfile"] = None,
availability_set: Optional["_models.SubResource"] = None,
virtual_machine_scale_set: Optional["_models.SubResource"] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
priority: Optional[Union[str, "_models.VirtualMachinePriorityTypes"]] = None,
eviction_policy: Optional[Union[str, "_models.VirtualMachineEvictionPolicyTypes"]] = None,
billing_profile: Optional["_models.BillingProfile"] = None,
host: Optional["_models.SubResource"] = None,
license_type: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:keyword identity: The identity of the virtual machine, if configured.
:paramtype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineIdentity
:keyword zones: The virtual machine zones.
:paramtype zones: list[str]
:keyword hardware_profile: Specifies the hardware settings for the virtual machine.
:paramtype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:keyword additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine.
:paramtype additional_capabilities:
~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:keyword os_profile: Specifies the operating system settings for the virtual machine.
:paramtype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:keyword network_profile: Specifies the network interfaces of the virtual machine.
:paramtype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:keyword diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:paramtype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:keyword availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set. :code:`<br>`:code:`<br>`This
property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
:paramtype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword virtual_machine_scale_set: Specifies information about the virtual machine scale set
that the virtual machine should be assigned to. Virtual machines specified in the same virtual
machine scale set are allocated to different nodes to maximize availability. Currently, a VM
can only be added to virtual machine scale set at creation time. An existing VM cannot be added
to a virtual machine scale set. :code:`<br>`:code:`<br>`This property cannot exist along with a
non-null properties.availabilitySet reference. :code:`<br>`:code:`<br>`Minimum api‐version:
2019‐03‐01.
:paramtype virtual_machine_scale_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the virtual machine should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword priority: Specifies the priority for the virtual machine.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01. Known values are: "Regular", "Low",
and "Spot".
:paramtype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:keyword eviction_policy: Specifies the eviction policy for the Azure Spot virtual machine.
Only supported value is 'Deallocate'. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
Known values are: "Deallocate" and "Delete".
:paramtype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:keyword billing_profile: Specifies the billing related details of a Azure Spot virtual
machine. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:paramtype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:keyword host: Specifies information about the dedicated host that the virtual machine resides
in. :code:`<br>`:code:`<br>`Minimum api-version: 2018-10-01.
:paramtype host: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype license_type: str
"""
super().__init__(location=location, tags=tags, **kwargs)
self.plan = plan
self.resources = None
self.identity = identity
self.zones = zones
self.hardware_profile = hardware_profile
self.storage_profile = storage_profile
self.additional_capabilities = additional_capabilities
self.os_profile = os_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.availability_set = availability_set
self.virtual_machine_scale_set = virtual_machine_scale_set
self.proximity_placement_group = proximity_placement_group
self.priority = priority
self.eviction_policy = eviction_policy
self.billing_profile = billing_profile
self.host = host
self.provisioning_state = None
self.instance_view = None
self.license_type = license_type
self.vm_id = None
[docs]class VirtualMachineAgentInstanceView(_serialization.Model):
"""The instance view of the VM Agent running on the virtual machine.
:ivar vm_agent_version: The VM Agent full version.
:vartype vm_agent_version: str
:ivar extension_handlers: The virtual machine extension handler instance view.
:vartype extension_handlers:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionHandlerInstanceView]
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_attribute_map = {
"vm_agent_version": {"key": "vmAgentVersion", "type": "str"},
"extension_handlers": {"key": "extensionHandlers", "type": "[VirtualMachineExtensionHandlerInstanceView]"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
vm_agent_version: Optional[str] = None,
extension_handlers: Optional[List["_models.VirtualMachineExtensionHandlerInstanceView"]] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
**kwargs: Any
) -> None:
"""
:keyword vm_agent_version: The VM Agent full version.
:paramtype vm_agent_version: str
:keyword extension_handlers: The virtual machine extension handler instance view.
:paramtype extension_handlers:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionHandlerInstanceView]
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.vm_agent_version = vm_agent_version
self.extension_handlers = extension_handlers
self.statuses = statuses
[docs]class VirtualMachineCaptureParameters(_serialization.Model):
"""Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
:ivar vhd_prefix: The captured virtual hard disk's name prefix. Required.
:vartype vhd_prefix: str
:ivar destination_container_name: The destination container name. Required.
:vartype destination_container_name: str
:ivar overwrite_vhds: Specifies whether to overwrite the destination virtual hard disk, in case
of conflict. Required.
:vartype overwrite_vhds: bool
"""
_validation = {
"vhd_prefix": {"required": True},
"destination_container_name": {"required": True},
"overwrite_vhds": {"required": True},
}
_attribute_map = {
"vhd_prefix": {"key": "vhdPrefix", "type": "str"},
"destination_container_name": {"key": "destinationContainerName", "type": "str"},
"overwrite_vhds": {"key": "overwriteVhds", "type": "bool"},
}
def __init__(
self, *, vhd_prefix: str, destination_container_name: str, overwrite_vhds: bool, **kwargs: Any
) -> None:
"""
:keyword vhd_prefix: The captured virtual hard disk's name prefix. Required.
:paramtype vhd_prefix: str
:keyword destination_container_name: The destination container name. Required.
:paramtype destination_container_name: str
:keyword overwrite_vhds: Specifies whether to overwrite the destination virtual hard disk, in
case of conflict. Required.
:paramtype overwrite_vhds: bool
"""
super().__init__(**kwargs)
self.vhd_prefix = vhd_prefix
self.destination_container_name = destination_container_name
self.overwrite_vhds = overwrite_vhds
[docs]class VirtualMachineCaptureResult(SubResource):
"""Output of virtual machine capture operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar schema: the schema of the captured virtual machine.
:vartype schema: str
:ivar content_version: the version of the content.
:vartype content_version: str
:ivar parameters: parameters of the captured virtual machine.
:vartype parameters: JSON
:ivar resources: a list of resource items of the captured virtual machine.
:vartype resources: list[JSON]
"""
_validation = {
"schema": {"readonly": True},
"content_version": {"readonly": True},
"parameters": {"readonly": True},
"resources": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"schema": {"key": "$schema", "type": "str"},
"content_version": {"key": "contentVersion", "type": "str"},
"parameters": {"key": "parameters", "type": "object"},
"resources": {"key": "resources", "type": "[object]"},
}
def __init__(self, *, id: Optional[str] = None, **kwargs: Any) -> None: # pylint: disable=redefined-builtin
"""
:keyword id: Resource Id.
:paramtype id: str
"""
super().__init__(id=id, **kwargs)
self.schema = None
self.content_version = None
self.parameters = None
self.resources = None
[docs]class VirtualMachineExtension(Resource): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine Extension.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:vartype force_update_tag: str
:ivar publisher: The name of the extension handler publisher.
:vartype publisher: str
:ivar type_properties_type: Specifies the type of the extension; an example is
"CustomScriptExtension".
:vartype type_properties_type: str
:ivar type_handler_version: Specifies the version of the script handler.
:vartype type_handler_version: str
:ivar auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:vartype auto_upgrade_minor_version: bool
:ivar settings: Json formatted public settings for the extension.
:vartype settings: JSON
:ivar protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:vartype protected_settings: JSON
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The virtual machine extension instance view.
:vartype instance_view:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"force_update_tag": {"key": "properties.forceUpdateTag", "type": "str"},
"publisher": {"key": "properties.publisher", "type": "str"},
"type_properties_type": {"key": "properties.type", "type": "str"},
"type_handler_version": {"key": "properties.typeHandlerVersion", "type": "str"},
"auto_upgrade_minor_version": {"key": "properties.autoUpgradeMinorVersion", "type": "bool"},
"settings": {"key": "properties.settings", "type": "object"},
"protected_settings": {"key": "properties.protectedSettings", "type": "object"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "VirtualMachineExtensionInstanceView"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
force_update_tag: Optional[str] = None,
publisher: Optional[str] = None,
type_properties_type: Optional[str] = None,
type_handler_version: Optional[str] = None,
auto_upgrade_minor_version: Optional[bool] = None,
settings: Optional[JSON] = None,
protected_settings: Optional[JSON] = None,
instance_view: Optional["_models.VirtualMachineExtensionInstanceView"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:paramtype force_update_tag: str
:keyword publisher: The name of the extension handler publisher.
:paramtype publisher: str
:keyword type_properties_type: Specifies the type of the extension; an example is
"CustomScriptExtension".
:paramtype type_properties_type: str
:keyword type_handler_version: Specifies the version of the script handler.
:paramtype type_handler_version: str
:keyword auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:paramtype auto_upgrade_minor_version: bool
:keyword settings: Json formatted public settings for the extension.
:paramtype settings: JSON
:keyword protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:paramtype protected_settings: JSON
:keyword instance_view: The virtual machine extension instance view.
:paramtype instance_view:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView
"""
super().__init__(location=location, tags=tags, **kwargs)
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type_properties_type = type_properties_type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
self.provisioning_state = None
self.instance_view = instance_view
[docs]class VirtualMachineExtensionHandlerInstanceView(_serialization.Model):
"""The instance view of a virtual machine extension handler.
:ivar type: Specifies the type of the extension; an example is "CustomScriptExtension".
:vartype type: str
:ivar type_handler_version: Specifies the version of the script handler.
:vartype type_handler_version: str
:ivar status: The extension handler status.
:vartype status: ~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus
"""
_attribute_map = {
"type": {"key": "type", "type": "str"},
"type_handler_version": {"key": "typeHandlerVersion", "type": "str"},
"status": {"key": "status", "type": "InstanceViewStatus"},
}
def __init__(
self,
*,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
status: Optional["_models.InstanceViewStatus"] = None,
**kwargs: Any
) -> None:
"""
:keyword type: Specifies the type of the extension; an example is "CustomScriptExtension".
:paramtype type: str
:keyword type_handler_version: Specifies the version of the script handler.
:paramtype type_handler_version: str
:keyword status: The extension handler status.
:paramtype status: ~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus
"""
super().__init__(**kwargs)
self.type = type
self.type_handler_version = type_handler_version
self.status = status
[docs]class VirtualMachineExtensionImage(Resource):
"""Describes a Virtual Machine Extension Image.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar operating_system: The operating system this extension supports.
:vartype operating_system: str
:ivar compute_role: The type of role (IaaS or PaaS) this extension supports.
:vartype compute_role: str
:ivar handler_schema: The schema defined by publisher, where extension consumers should provide
settings in a matching schema.
:vartype handler_schema: str
:ivar vm_scale_set_enabled: Whether the extension can be used on xRP VMScaleSets. By default
existing extensions are usable on scalesets, but there might be cases where a publisher wants
to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
:vartype vm_scale_set_enabled: bool
:ivar supports_multiple_extensions: Whether the handler can support multiple extensions.
:vartype supports_multiple_extensions: bool
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"operating_system": {"key": "properties.operatingSystem", "type": "str"},
"compute_role": {"key": "properties.computeRole", "type": "str"},
"handler_schema": {"key": "properties.handlerSchema", "type": "str"},
"vm_scale_set_enabled": {"key": "properties.vmScaleSetEnabled", "type": "bool"},
"supports_multiple_extensions": {"key": "properties.supportsMultipleExtensions", "type": "bool"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
operating_system: Optional[str] = None,
compute_role: Optional[str] = None,
handler_schema: Optional[str] = None,
vm_scale_set_enabled: Optional[bool] = None,
supports_multiple_extensions: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword operating_system: The operating system this extension supports.
:paramtype operating_system: str
:keyword compute_role: The type of role (IaaS or PaaS) this extension supports.
:paramtype compute_role: str
:keyword handler_schema: The schema defined by publisher, where extension consumers should
provide settings in a matching schema.
:paramtype handler_schema: str
:keyword vm_scale_set_enabled: Whether the extension can be used on xRP VMScaleSets. By default
existing extensions are usable on scalesets, but there might be cases where a publisher wants
to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
:paramtype vm_scale_set_enabled: bool
:keyword supports_multiple_extensions: Whether the handler can support multiple extensions.
:paramtype supports_multiple_extensions: bool
"""
super().__init__(location=location, tags=tags, **kwargs)
self.operating_system = operating_system
self.compute_role = compute_role
self.handler_schema = handler_schema
self.vm_scale_set_enabled = vm_scale_set_enabled
self.supports_multiple_extensions = supports_multiple_extensions
[docs]class VirtualMachineExtensionInstanceView(_serialization.Model):
"""The instance view of a virtual machine extension.
:ivar name: The virtual machine extension name.
:vartype name: str
:ivar type: Specifies the type of the extension; an example is "CustomScriptExtension".
:vartype type: str
:ivar type_handler_version: Specifies the version of the script handler.
:vartype type_handler_version: str
:ivar substatuses: The resource status information.
:vartype substatuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"type_handler_version": {"key": "typeHandlerVersion", "type": "str"},
"substatuses": {"key": "substatuses", "type": "[InstanceViewStatus]"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
substatuses: Optional[List["_models.InstanceViewStatus"]] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The virtual machine extension name.
:paramtype name: str
:keyword type: Specifies the type of the extension; an example is "CustomScriptExtension".
:paramtype type: str
:keyword type_handler_version: Specifies the version of the script handler.
:paramtype type_handler_version: str
:keyword substatuses: The resource status information.
:paramtype substatuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.name = name
self.type = type
self.type_handler_version = type_handler_version
self.substatuses = substatuses
self.statuses = statuses
[docs]class VirtualMachineExtensionsListResult(_serialization.Model):
"""The List Extension operation response.
:ivar value: The list of extensions.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
"""
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineExtension]"},
}
def __init__(self, *, value: Optional[List["_models.VirtualMachineExtension"]] = None, **kwargs: Any) -> None:
"""
:keyword value: The list of extensions.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
"""
super().__init__(**kwargs)
self.value = value
[docs]class VirtualMachineExtensionUpdate(UpdateResource):
"""Describes a Virtual Machine Extension.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:vartype force_update_tag: str
:ivar publisher: The name of the extension handler publisher.
:vartype publisher: str
:ivar type: Specifies the type of the extension; an example is "CustomScriptExtension".
:vartype type: str
:ivar type_handler_version: Specifies the version of the script handler.
:vartype type_handler_version: str
:ivar auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:vartype auto_upgrade_minor_version: bool
:ivar settings: Json formatted public settings for the extension.
:vartype settings: JSON
:ivar protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:vartype protected_settings: JSON
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"force_update_tag": {"key": "properties.forceUpdateTag", "type": "str"},
"publisher": {"key": "properties.publisher", "type": "str"},
"type": {"key": "properties.type", "type": "str"},
"type_handler_version": {"key": "properties.typeHandlerVersion", "type": "str"},
"auto_upgrade_minor_version": {"key": "properties.autoUpgradeMinorVersion", "type": "bool"},
"settings": {"key": "properties.settings", "type": "object"},
"protected_settings": {"key": "properties.protectedSettings", "type": "object"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
force_update_tag: Optional[str] = None,
publisher: Optional[str] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
auto_upgrade_minor_version: Optional[bool] = None,
settings: Optional[JSON] = None,
protected_settings: Optional[JSON] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:paramtype force_update_tag: str
:keyword publisher: The name of the extension handler publisher.
:paramtype publisher: str
:keyword type: Specifies the type of the extension; an example is "CustomScriptExtension".
:paramtype type: str
:keyword type_handler_version: Specifies the version of the script handler.
:paramtype type_handler_version: str
:keyword auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:paramtype auto_upgrade_minor_version: bool
:keyword settings: Json formatted public settings for the extension.
:paramtype settings: JSON
:keyword protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:paramtype protected_settings: JSON
"""
super().__init__(tags=tags, **kwargs)
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type = type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
[docs]class VirtualMachineHealthStatus(_serialization.Model):
"""The health status of the VM.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar status: The health status information for the VM.
:vartype status: ~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus
"""
_validation = {
"status": {"readonly": True},
}
_attribute_map = {
"status": {"key": "status", "type": "InstanceViewStatus"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.status = None
[docs]class VirtualMachineIdentity(_serialization.Model):
"""Identity for the virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of virtual machine identity. This property will only be
provided for a system assigned identity.
:vartype principal_id: str
:ivar tenant_id: The tenant id associated with the virtual machine. This property will only be
provided for a system assigned identity.
:vartype tenant_id: str
:ivar type: The type of identity used for the virtual machine. The type 'SystemAssigned,
UserAssigned' includes both an implicitly created identity and a set of user assigned
identities. The type 'None' will remove any identities from the virtual machine. Known values
are: "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", and "None".
:vartype type: str or ~azure.mgmt.compute.v2019_03_01.models.ResourceIdentityType
:ivar user_assigned_identities: The list of user identities associated with the Virtual
Machine. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:vartype user_assigned_identities: dict[str,
~azure.mgmt.compute.v2019_03_01.models.UserAssignedIdentitiesValue]
"""
_validation = {
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"type": {"key": "type", "type": "str"},
"user_assigned_identities": {"key": "userAssignedIdentities", "type": "{UserAssignedIdentitiesValue}"},
}
def __init__(
self,
*,
type: Optional[Union[str, "_models.ResourceIdentityType"]] = None,
user_assigned_identities: Optional[Dict[str, "_models.UserAssignedIdentitiesValue"]] = None,
**kwargs: Any
) -> None:
"""
:keyword type: The type of identity used for the virtual machine. The type 'SystemAssigned,
UserAssigned' includes both an implicitly created identity and a set of user assigned
identities. The type 'None' will remove any identities from the virtual machine. Known values
are: "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", and "None".
:paramtype type: str or ~azure.mgmt.compute.v2019_03_01.models.ResourceIdentityType
:keyword user_assigned_identities: The list of user identities associated with the Virtual
Machine. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:paramtype user_assigned_identities: dict[str,
~azure.mgmt.compute.v2019_03_01.models.UserAssignedIdentitiesValue]
"""
super().__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
self.user_assigned_identities = user_assigned_identities
[docs]class VirtualMachineImageResource(SubResource):
"""Virtual machine image resource information.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The name of the resource. Required.
:vartype name: str
:ivar location: The supported Azure location of the resource. Required.
:vartype location: str
:ivar tags: Specifies the tags that are assigned to the virtual machine. For more information
about using tags, see `Using tags to organize your Azure resources
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:vartype tags: dict[str, str]
"""
_validation = {
"name": {"required": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
name: str,
location: str,
id: Optional[str] = None, # pylint: disable=redefined-builtin
tags: Optional[Dict[str, str]] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The name of the resource. Required.
:paramtype name: str
:keyword location: The supported Azure location of the resource. Required.
:paramtype location: str
:keyword tags: Specifies the tags that are assigned to the virtual machine. For more
information about using tags, see `Using tags to organize your Azure resources
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:paramtype tags: dict[str, str]
"""
super().__init__(id=id, **kwargs)
self.name = name
self.location = location
self.tags = tags
[docs]class VirtualMachineImage(VirtualMachineImageResource):
"""Describes a Virtual Machine Image.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The name of the resource. Required.
:vartype name: str
:ivar location: The supported Azure location of the resource. Required.
:vartype location: str
:ivar tags: Specifies the tags that are assigned to the virtual machine. For more information
about using tags, see `Using tags to organize your Azure resources
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:vartype tags: dict[str, str]
:ivar plan: Used for establishing the purchase context of any 3rd Party artifact through
MarketPlace.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.PurchasePlan
:ivar os_disk_image: Contains the os disk image information.
:vartype os_disk_image: ~azure.mgmt.compute.v2019_03_01.models.OSDiskImage
:ivar data_disk_images:
:vartype data_disk_images: list[~azure.mgmt.compute.v2019_03_01.models.DataDiskImage]
:ivar automatic_os_upgrade_properties: Describes automatic OS upgrade properties on the image.
:vartype automatic_os_upgrade_properties:
~azure.mgmt.compute.v2019_03_01.models.AutomaticOSUpgradeProperties
:ivar hyper_v_generation: Specifies the HyperVGeneration Type. Known values are: "V1" and "V2".
:vartype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
_validation = {
"name": {"required": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"plan": {"key": "properties.plan", "type": "PurchasePlan"},
"os_disk_image": {"key": "properties.osDiskImage", "type": "OSDiskImage"},
"data_disk_images": {"key": "properties.dataDiskImages", "type": "[DataDiskImage]"},
"automatic_os_upgrade_properties": {
"key": "properties.automaticOSUpgradeProperties",
"type": "AutomaticOSUpgradeProperties",
},
"hyper_v_generation": {"key": "properties.hyperVGeneration", "type": "str"},
}
def __init__(
self,
*,
name: str,
location: str,
id: Optional[str] = None, # pylint: disable=redefined-builtin
tags: Optional[Dict[str, str]] = None,
plan: Optional["_models.PurchasePlan"] = None,
os_disk_image: Optional["_models.OSDiskImage"] = None,
data_disk_images: Optional[List["_models.DataDiskImage"]] = None,
automatic_os_upgrade_properties: Optional["_models.AutomaticOSUpgradeProperties"] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGenerationTypes"]] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The name of the resource. Required.
:paramtype name: str
:keyword location: The supported Azure location of the resource. Required.
:paramtype location: str
:keyword tags: Specifies the tags that are assigned to the virtual machine. For more
information about using tags, see `Using tags to organize your Azure resources
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:paramtype tags: dict[str, str]
:keyword plan: Used for establishing the purchase context of any 3rd Party artifact through
MarketPlace.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.PurchasePlan
:keyword os_disk_image: Contains the os disk image information.
:paramtype os_disk_image: ~azure.mgmt.compute.v2019_03_01.models.OSDiskImage
:keyword data_disk_images:
:paramtype data_disk_images: list[~azure.mgmt.compute.v2019_03_01.models.DataDiskImage]
:keyword automatic_os_upgrade_properties: Describes automatic OS upgrade properties on the
image.
:paramtype automatic_os_upgrade_properties:
~azure.mgmt.compute.v2019_03_01.models.AutomaticOSUpgradeProperties
:keyword hyper_v_generation: Specifies the HyperVGeneration Type. Known values are: "V1" and
"V2".
:paramtype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationTypes
"""
super().__init__(id=id, name=name, location=location, tags=tags, **kwargs)
self.plan = plan
self.os_disk_image = os_disk_image
self.data_disk_images = data_disk_images
self.automatic_os_upgrade_properties = automatic_os_upgrade_properties
self.hyper_v_generation = hyper_v_generation
[docs]class VirtualMachineInstanceView(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""The instance view of a virtual machine.
:ivar platform_update_domain: Specifies the update domain of the virtual machine.
:vartype platform_update_domain: int
:ivar platform_fault_domain: Specifies the fault domain of the virtual machine.
:vartype platform_fault_domain: int
:ivar computer_name: The computer name assigned to the virtual machine.
:vartype computer_name: str
:ivar os_name: The Operating System running on the virtual machine.
:vartype os_name: str
:ivar os_version: The version of Operating System running on the virtual machine.
:vartype os_version: str
:ivar hyper_v_generation: Specifies the HyperVGeneration Type associated with a resource. Known
values are: "V1" and "V2".
:vartype hyper_v_generation: str or ~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationType
:ivar rdp_thumb_print: The Remote desktop certificate thumbprint.
:vartype rdp_thumb_print: str
:ivar vm_agent: The VM Agent running on the virtual machine.
:vartype vm_agent: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineAgentInstanceView
:ivar maintenance_redeploy_status: The Maintenance Operation status on the virtual machine.
:vartype maintenance_redeploy_status:
~azure.mgmt.compute.v2019_03_01.models.MaintenanceRedeployStatus
:ivar disks: The virtual machine disk information.
:vartype disks: list[~azure.mgmt.compute.v2019_03_01.models.DiskInstanceView]
:ivar extensions: The extensions information.
:vartype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView]
:ivar boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:vartype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnosticsInstanceView
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_attribute_map = {
"platform_update_domain": {"key": "platformUpdateDomain", "type": "int"},
"platform_fault_domain": {"key": "platformFaultDomain", "type": "int"},
"computer_name": {"key": "computerName", "type": "str"},
"os_name": {"key": "osName", "type": "str"},
"os_version": {"key": "osVersion", "type": "str"},
"hyper_v_generation": {"key": "hyperVGeneration", "type": "str"},
"rdp_thumb_print": {"key": "rdpThumbPrint", "type": "str"},
"vm_agent": {"key": "vmAgent", "type": "VirtualMachineAgentInstanceView"},
"maintenance_redeploy_status": {"key": "maintenanceRedeployStatus", "type": "MaintenanceRedeployStatus"},
"disks": {"key": "disks", "type": "[DiskInstanceView]"},
"extensions": {"key": "extensions", "type": "[VirtualMachineExtensionInstanceView]"},
"boot_diagnostics": {"key": "bootDiagnostics", "type": "BootDiagnosticsInstanceView"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(
self,
*,
platform_update_domain: Optional[int] = None,
platform_fault_domain: Optional[int] = None,
computer_name: Optional[str] = None,
os_name: Optional[str] = None,
os_version: Optional[str] = None,
hyper_v_generation: Optional[Union[str, "_models.HyperVGenerationType"]] = None,
rdp_thumb_print: Optional[str] = None,
vm_agent: Optional["_models.VirtualMachineAgentInstanceView"] = None,
maintenance_redeploy_status: Optional["_models.MaintenanceRedeployStatus"] = None,
disks: Optional[List["_models.DiskInstanceView"]] = None,
extensions: Optional[List["_models.VirtualMachineExtensionInstanceView"]] = None,
boot_diagnostics: Optional["_models.BootDiagnosticsInstanceView"] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
**kwargs: Any
) -> None:
"""
:keyword platform_update_domain: Specifies the update domain of the virtual machine.
:paramtype platform_update_domain: int
:keyword platform_fault_domain: Specifies the fault domain of the virtual machine.
:paramtype platform_fault_domain: int
:keyword computer_name: The computer name assigned to the virtual machine.
:paramtype computer_name: str
:keyword os_name: The Operating System running on the virtual machine.
:paramtype os_name: str
:keyword os_version: The version of Operating System running on the virtual machine.
:paramtype os_version: str
:keyword hyper_v_generation: Specifies the HyperVGeneration Type associated with a resource.
Known values are: "V1" and "V2".
:paramtype hyper_v_generation: str or
~azure.mgmt.compute.v2019_03_01.models.HyperVGenerationType
:keyword rdp_thumb_print: The Remote desktop certificate thumbprint.
:paramtype rdp_thumb_print: str
:keyword vm_agent: The VM Agent running on the virtual machine.
:paramtype vm_agent: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineAgentInstanceView
:keyword maintenance_redeploy_status: The Maintenance Operation status on the virtual machine.
:paramtype maintenance_redeploy_status:
~azure.mgmt.compute.v2019_03_01.models.MaintenanceRedeployStatus
:keyword disks: The virtual machine disk information.
:paramtype disks: list[~azure.mgmt.compute.v2019_03_01.models.DiskInstanceView]
:keyword extensions: The extensions information.
:paramtype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView]
:keyword boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:paramtype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnosticsInstanceView
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.platform_update_domain = platform_update_domain
self.platform_fault_domain = platform_fault_domain
self.computer_name = computer_name
self.os_name = os_name
self.os_version = os_version
self.hyper_v_generation = hyper_v_generation
self.rdp_thumb_print = rdp_thumb_print
self.vm_agent = vm_agent
self.maintenance_redeploy_status = maintenance_redeploy_status
self.disks = disks
self.extensions = extensions
self.boot_diagnostics = boot_diagnostics
self.statuses = statuses
[docs]class VirtualMachineListResult(_serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of virtual machines. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachine]
:ivar next_link: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch
the next page of Virtual Machines.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachine]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachine"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of virtual machines. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachine]
:keyword next_link: The URI to fetch the next page of VMs. Call ListNext() with this URI to
fetch the next page of Virtual Machines.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineReimageParameters(_serialization.Model):
"""Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be
reimaged.
:ivar temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This temp
disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:vartype temp_disk: bool
"""
_attribute_map = {
"temp_disk": {"key": "tempDisk", "type": "bool"},
}
def __init__(self, *, temp_disk: Optional[bool] = None, **kwargs: Any) -> None:
"""
:keyword temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This
temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:paramtype temp_disk: bool
"""
super().__init__(**kwargs)
self.temp_disk = temp_disk
[docs]class VirtualMachineScaleSet(Resource): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine Scale Set.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: The virtual machine scale set sku.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:ivar identity: The identity of the virtual machine scale set, if configured.
:vartype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentity
:ivar zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when
you create the scale set.
:vartype zones: list[str]
:ivar upgrade_policy: The upgrade policy.
:vartype upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.UpgradePolicy
:ivar automatic_repairs_policy: Policy for automatic repairs.
:vartype automatic_repairs_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticRepairsPolicy
:ivar virtual_machine_profile: The virtual machine profile.
:vartype virtual_machine_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMProfile
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
:vartype overprovision: bool
:ivar do_not_run_extensions_on_overprovisioned_v_ms: When Overprovision is enabled, extensions
are launched only on the requested number of VMs which are finally kept. This property will
hence ensure that the extensions do not run on the extra overprovisioned VMs.
:vartype do_not_run_extensions_on_overprovisioned_v_ms: bool
:ivar unique_id: Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
:vartype unique_id: str
:ivar single_placement_group: When true this limits the scale set to a single placement group,
of max size 100 virtual machines.
:vartype single_placement_group: bool
:ivar zone_balance: Whether to force strictly even Virtual Machine distribution cross x-zones
in case there is zone outage.
:vartype zone_balance: bool
:ivar platform_fault_domain_count: Fault Domain count for each placement group.
:vartype platform_fault_domain_count: int
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the virtual machine scale set should be assigned to. :code:`<br>`:code:`<br>`Minimum
api-version: 2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar additional_capabilities: Specifies additional capabilities enabled or disabled on the
Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines
have the capability to support attaching managed data disks with UltraSSD_LRS storage account
type.
:vartype additional_capabilities: ~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:ivar scale_in_policy: Specifies the scale-in policy that decides which virtual machines are
chosen for removal when a Virtual Machine Scale Set is scaled-in.
:vartype scale_in_policy: ~azure.mgmt.compute.v2019_03_01.models.ScaleInPolicy
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"provisioning_state": {"readonly": True},
"unique_id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
"plan": {"key": "plan", "type": "Plan"},
"identity": {"key": "identity", "type": "VirtualMachineScaleSetIdentity"},
"zones": {"key": "zones", "type": "[str]"},
"upgrade_policy": {"key": "properties.upgradePolicy", "type": "UpgradePolicy"},
"automatic_repairs_policy": {"key": "properties.automaticRepairsPolicy", "type": "AutomaticRepairsPolicy"},
"virtual_machine_profile": {
"key": "properties.virtualMachineProfile",
"type": "VirtualMachineScaleSetVMProfile",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"overprovision": {"key": "properties.overprovision", "type": "bool"},
"do_not_run_extensions_on_overprovisioned_v_ms": {
"key": "properties.doNotRunExtensionsOnOverprovisionedVMs",
"type": "bool",
},
"unique_id": {"key": "properties.uniqueId", "type": "str"},
"single_placement_group": {"key": "properties.singlePlacementGroup", "type": "bool"},
"zone_balance": {"key": "properties.zoneBalance", "type": "bool"},
"platform_fault_domain_count": {"key": "properties.platformFaultDomainCount", "type": "int"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
"additional_capabilities": {"key": "properties.additionalCapabilities", "type": "AdditionalCapabilities"},
"scale_in_policy": {"key": "properties.scaleInPolicy", "type": "ScaleInPolicy"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
plan: Optional["_models.Plan"] = None,
identity: Optional["_models.VirtualMachineScaleSetIdentity"] = None,
zones: Optional[List[str]] = None,
upgrade_policy: Optional["_models.UpgradePolicy"] = None,
automatic_repairs_policy: Optional["_models.AutomaticRepairsPolicy"] = None,
virtual_machine_profile: Optional["_models.VirtualMachineScaleSetVMProfile"] = None,
overprovision: Optional[bool] = None,
do_not_run_extensions_on_overprovisioned_v_ms: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
zone_balance: Optional[bool] = None,
platform_fault_domain_count: Optional[int] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
additional_capabilities: Optional["_models.AdditionalCapabilities"] = None,
scale_in_policy: Optional["_models.ScaleInPolicy"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The virtual machine scale set sku.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:keyword plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:keyword identity: The identity of the virtual machine scale set, if configured.
:paramtype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentity
:keyword zones: The virtual machine scale set zones. NOTE: Availability zones can only be set
when you create the scale set.
:paramtype zones: list[str]
:keyword upgrade_policy: The upgrade policy.
:paramtype upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.UpgradePolicy
:keyword automatic_repairs_policy: Policy for automatic repairs.
:paramtype automatic_repairs_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticRepairsPolicy
:keyword virtual_machine_profile: The virtual machine profile.
:paramtype virtual_machine_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMProfile
:keyword overprovision: Specifies whether the Virtual Machine Scale Set should be
overprovisioned.
:paramtype overprovision: bool
:keyword do_not_run_extensions_on_overprovisioned_v_ms: When Overprovision is enabled,
extensions are launched only on the requested number of VMs which are finally kept. This
property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
:paramtype do_not_run_extensions_on_overprovisioned_v_ms: bool
:keyword single_placement_group: When true this limits the scale set to a single placement
group, of max size 100 virtual machines.
:paramtype single_placement_group: bool
:keyword zone_balance: Whether to force strictly even Virtual Machine distribution cross
x-zones in case there is zone outage.
:paramtype zone_balance: bool
:keyword platform_fault_domain_count: Fault Domain count for each placement group.
:paramtype platform_fault_domain_count: int
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the virtual machine scale set should be assigned to. :code:`<br>`:code:`<br>`Minimum
api-version: 2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword additional_capabilities: Specifies additional capabilities enabled or disabled on the
Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines
have the capability to support attaching managed data disks with UltraSSD_LRS storage account
type.
:paramtype additional_capabilities:
~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:keyword scale_in_policy: Specifies the scale-in policy that decides which virtual machines are
chosen for removal when a Virtual Machine Scale Set is scaled-in.
:paramtype scale_in_policy: ~azure.mgmt.compute.v2019_03_01.models.ScaleInPolicy
"""
super().__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.plan = plan
self.identity = identity
self.zones = zones
self.upgrade_policy = upgrade_policy
self.automatic_repairs_policy = automatic_repairs_policy
self.virtual_machine_profile = virtual_machine_profile
self.provisioning_state = None
self.overprovision = overprovision
self.do_not_run_extensions_on_overprovisioned_v_ms = do_not_run_extensions_on_overprovisioned_v_ms
self.unique_id = None
self.single_placement_group = single_placement_group
self.zone_balance = zone_balance
self.platform_fault_domain_count = platform_fault_domain_count
self.proximity_placement_group = proximity_placement_group
self.additional_capabilities = additional_capabilities
self.scale_in_policy = scale_in_policy
[docs]class VirtualMachineScaleSetDataDisk(_serialization.Model):
"""Describes a virtual machine scale set data disk.
All required parameters must be populated in order to send to Azure.
:ivar name: The disk name.
:vartype name: str
:ivar lun: Specifies the logical unit number of the data disk. This value is used to identify
data disks within the VM and therefore must be unique for each data disk attached to a VM.
Required.
:vartype lun: int
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:vartype write_accelerator_enabled: bool
:ivar create_option: The create option. Required. Known values are: "FromImage", "Empty", and
"Attach".
:vartype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:ivar disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar managed_disk: The managed disk parameters.
:vartype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
_validation = {
"lun": {"required": True},
"create_option": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"lun": {"key": "lun", "type": "int"},
"caching": {"key": "caching", "type": "str"},
"write_accelerator_enabled": {"key": "writeAcceleratorEnabled", "type": "bool"},
"create_option": {"key": "createOption", "type": "str"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"managed_disk": {"key": "managedDisk", "type": "VirtualMachineScaleSetManagedDiskParameters"},
}
def __init__(
self,
*,
lun: int,
create_option: Union[str, "_models.DiskCreateOptionTypes"],
name: Optional[str] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
write_accelerator_enabled: Optional[bool] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["_models.VirtualMachineScaleSetManagedDiskParameters"] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The disk name.
:paramtype name: str
:keyword lun: Specifies the logical unit number of the data disk. This value is used to
identify data disks within the VM and therefore must be unique for each data disk attached to a
VM. Required.
:paramtype lun: int
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:paramtype write_accelerator_enabled: bool
:keyword create_option: The create option. Required. Known values are: "FromImage", "Empty",
and "Attach".
:paramtype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:keyword disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can
be used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword managed_disk: The managed disk parameters.
:paramtype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
super().__init__(**kwargs)
self.name = name
self.lun = lun
self.caching = caching
self.write_accelerator_enabled = write_accelerator_enabled
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
[docs]class VirtualMachineScaleSetExtension(SubResourceReadOnly): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine Scale Set Extension.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The name of the extension.
:vartype name: str
:ivar force_update_tag: If a value is provided and is different from the previous value, the
extension handler will be forced to update even if the extension configuration has not changed.
:vartype force_update_tag: str
:ivar publisher: The name of the extension handler publisher.
:vartype publisher: str
:ivar type: Specifies the type of the extension; an example is "CustomScriptExtension".
:vartype type: str
:ivar type_handler_version: Specifies the version of the script handler.
:vartype type_handler_version: str
:ivar auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:vartype auto_upgrade_minor_version: bool
:ivar settings: Json formatted public settings for the extension.
:vartype settings: JSON
:ivar protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:vartype protected_settings: JSON
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar provision_after_extensions: Collection of extension names after which this extension
needs to be provisioned.
:vartype provision_after_extensions: list[str]
"""
_validation = {
"id": {"readonly": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"force_update_tag": {"key": "properties.forceUpdateTag", "type": "str"},
"publisher": {"key": "properties.publisher", "type": "str"},
"type": {"key": "properties.type", "type": "str"},
"type_handler_version": {"key": "properties.typeHandlerVersion", "type": "str"},
"auto_upgrade_minor_version": {"key": "properties.autoUpgradeMinorVersion", "type": "bool"},
"settings": {"key": "properties.settings", "type": "object"},
"protected_settings": {"key": "properties.protectedSettings", "type": "object"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"provision_after_extensions": {"key": "properties.provisionAfterExtensions", "type": "[str]"},
}
def __init__(
self,
*,
name: Optional[str] = None,
force_update_tag: Optional[str] = None,
publisher: Optional[str] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
auto_upgrade_minor_version: Optional[bool] = None,
settings: Optional[JSON] = None,
protected_settings: Optional[JSON] = None,
provision_after_extensions: Optional[List[str]] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The name of the extension.
:paramtype name: str
:keyword force_update_tag: If a value is provided and is different from the previous value, the
extension handler will be forced to update even if the extension configuration has not changed.
:paramtype force_update_tag: str
:keyword publisher: The name of the extension handler publisher.
:paramtype publisher: str
:keyword type: Specifies the type of the extension; an example is "CustomScriptExtension".
:paramtype type: str
:keyword type_handler_version: Specifies the version of the script handler.
:paramtype type_handler_version: str
:keyword auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:paramtype auto_upgrade_minor_version: bool
:keyword settings: Json formatted public settings for the extension.
:paramtype settings: JSON
:keyword protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:paramtype protected_settings: JSON
:keyword provision_after_extensions: Collection of extension names after which this extension
needs to be provisioned.
:paramtype provision_after_extensions: list[str]
"""
super().__init__(**kwargs)
self.name = name
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type = type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
self.provisioning_state = None
self.provision_after_extensions = provision_after_extensions
[docs]class VirtualMachineScaleSetExtensionListResult(_serialization.Model):
"""The List VM scale set extension operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of VM scale set extensions. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension]
:ivar next_link: The uri to fetch the next page of VM scale set extensions. Call ListNext()
with this to fetch the next page of VM scale set extensions.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineScaleSetExtension]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachineScaleSetExtension"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of VM scale set extensions. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension]
:keyword next_link: The uri to fetch the next page of VM scale set extensions. Call ListNext()
with this to fetch the next page of VM scale set extensions.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetExtensionProfile(_serialization.Model):
"""Describes a virtual machine scale set extension profile.
:ivar extensions: The virtual machine scale set child extension resources.
:vartype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension]
"""
_attribute_map = {
"extensions": {"key": "extensions", "type": "[VirtualMachineScaleSetExtension]"},
}
def __init__(
self, *, extensions: Optional[List["_models.VirtualMachineScaleSetExtension"]] = None, **kwargs: Any
) -> None:
"""
:keyword extensions: The virtual machine scale set child extension resources.
:paramtype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtension]
"""
super().__init__(**kwargs)
self.extensions = extensions
[docs]class VirtualMachineScaleSetIdentity(_serialization.Model):
"""Identity for the virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of virtual machine scale set identity. This property will
only be provided for a system assigned identity.
:vartype principal_id: str
:ivar tenant_id: The tenant id associated with the virtual machine scale set. This property
will only be provided for a system assigned identity.
:vartype tenant_id: str
:ivar type: The type of identity used for the virtual machine scale set. The type
'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user
assigned identities. The type 'None' will remove any identities from the virtual machine scale
set. Known values are: "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", and
"None".
:vartype type: str or ~azure.mgmt.compute.v2019_03_01.models.ResourceIdentityType
:ivar user_assigned_identities: The list of user identities associated with the virtual machine
scale set. The user identity dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:vartype user_assigned_identities: dict[str,
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue]
"""
_validation = {
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"type": {"key": "type", "type": "str"},
"user_assigned_identities": {
"key": "userAssignedIdentities",
"type": "{VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue}",
},
}
def __init__(
self,
*,
type: Optional[Union[str, "_models.ResourceIdentityType"]] = None,
user_assigned_identities: Optional[
Dict[str, "_models.VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue"]
] = None,
**kwargs: Any
) -> None:
"""
:keyword type: The type of identity used for the virtual machine scale set. The type
'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user
assigned identities. The type 'None' will remove any identities from the virtual machine scale
set. Known values are: "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", and
"None".
:paramtype type: str or ~azure.mgmt.compute.v2019_03_01.models.ResourceIdentityType
:keyword user_assigned_identities: The list of user identities associated with the virtual
machine scale set. The user identity dictionary key references will be ARM resource ids in the
form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:paramtype user_assigned_identities: dict[str,
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue]
"""
super().__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
self.user_assigned_identities = user_assigned_identities
[docs]class VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue(_serialization.Model):
"""VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of user assigned identity.
:vartype principal_id: str
:ivar client_id: The client id of user assigned identity.
:vartype client_id: str
"""
_validation = {
"principal_id": {"readonly": True},
"client_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"client_id": {"key": "clientId", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.principal_id = None
self.client_id = None
[docs]class VirtualMachineScaleSetInstanceView(_serialization.Model):
"""The instance view of a virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar virtual_machine: The instance view status summary for the virtual machine scale set.
:vartype virtual_machine:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetInstanceViewStatusesSummary
:ivar extensions: The extensions information.
:vartype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMExtensionsSummary]
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
_validation = {
"virtual_machine": {"readonly": True},
"extensions": {"readonly": True},
}
_attribute_map = {
"virtual_machine": {"key": "virtualMachine", "type": "VirtualMachineScaleSetInstanceViewStatusesSummary"},
"extensions": {"key": "extensions", "type": "[VirtualMachineScaleSetVMExtensionsSummary]"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
}
def __init__(self, *, statuses: Optional[List["_models.InstanceViewStatus"]] = None, **kwargs: Any) -> None:
"""
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
"""
super().__init__(**kwargs)
self.virtual_machine = None
self.extensions = None
self.statuses = statuses
[docs]class VirtualMachineScaleSetInstanceViewStatusesSummary(_serialization.Model):
"""Instance view statuses summary for virtual machines of a virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar statuses_summary: The extensions information.
:vartype statuses_summary:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineStatusCodeCount]
"""
_validation = {
"statuses_summary": {"readonly": True},
}
_attribute_map = {
"statuses_summary": {"key": "statusesSummary", "type": "[VirtualMachineStatusCodeCount]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.statuses_summary = None
[docs]class VirtualMachineScaleSetIPConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's IP configuration.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The IP configuration name. Required.
:vartype name: str
:ivar subnet: Specifies the identifier of the subnet.
:vartype subnet: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:ivar primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:vartype primary: bool
:ivar public_ip_address_configuration: The publicIPAddressConfiguration.
:vartype public_ip_address_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfiguration
:ivar private_ip_address_version: Available from Api-Version 2017-03-30 onwards, it represents
whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible
values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".
:vartype private_ip_address_version: str or ~azure.mgmt.compute.v2019_03_01.models.IPVersion
:ivar application_gateway_backend_address_pools: Specifies an array of references to backend
address pools of application gateways. A scale set can reference backend address pools of
multiple application gateways. Multiple scale sets cannot use the same application gateway.
:vartype application_gateway_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar application_security_groups: Specifies an array of references to application security
group.
:vartype application_security_groups: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar load_balancer_backend_address_pools: Specifies an array of references to backend address
pools of load balancers. A scale set can reference backend address pools of one public and one
internal load balancer. Multiple scale sets cannot use the same load balancer.
:vartype load_balancer_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar load_balancer_inbound_nat_pools: Specifies an array of references to inbound Nat pools of
the load balancers. A scale set can reference inbound nat pools of one public and one internal
load balancer. Multiple scale sets cannot use the same load balancer.
:vartype load_balancer_inbound_nat_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"subnet": {"key": "properties.subnet", "type": "ApiEntityReference"},
"primary": {"key": "properties.primary", "type": "bool"},
"public_ip_address_configuration": {
"key": "properties.publicIPAddressConfiguration",
"type": "VirtualMachineScaleSetPublicIPAddressConfiguration",
},
"private_ip_address_version": {"key": "properties.privateIPAddressVersion", "type": "str"},
"application_gateway_backend_address_pools": {
"key": "properties.applicationGatewayBackendAddressPools",
"type": "[SubResource]",
},
"application_security_groups": {"key": "properties.applicationSecurityGroups", "type": "[SubResource]"},
"load_balancer_backend_address_pools": {
"key": "properties.loadBalancerBackendAddressPools",
"type": "[SubResource]",
},
"load_balancer_inbound_nat_pools": {"key": "properties.loadBalancerInboundNatPools", "type": "[SubResource]"},
}
def __init__(
self,
*,
name: str,
id: Optional[str] = None, # pylint: disable=redefined-builtin
subnet: Optional["_models.ApiEntityReference"] = None,
primary: Optional[bool] = None,
public_ip_address_configuration: Optional["_models.VirtualMachineScaleSetPublicIPAddressConfiguration"] = None,
private_ip_address_version: Optional[Union[str, "_models.IPVersion"]] = None,
application_gateway_backend_address_pools: Optional[List["_models.SubResource"]] = None,
application_security_groups: Optional[List["_models.SubResource"]] = None,
load_balancer_backend_address_pools: Optional[List["_models.SubResource"]] = None,
load_balancer_inbound_nat_pools: Optional[List["_models.SubResource"]] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The IP configuration name. Required.
:paramtype name: str
:keyword subnet: Specifies the identifier of the subnet.
:paramtype subnet: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:keyword primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:paramtype primary: bool
:keyword public_ip_address_configuration: The publicIPAddressConfiguration.
:paramtype public_ip_address_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfiguration
:keyword private_ip_address_version: Available from Api-Version 2017-03-30 onwards, it
represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.
Possible values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".
:paramtype private_ip_address_version: str or ~azure.mgmt.compute.v2019_03_01.models.IPVersion
:keyword application_gateway_backend_address_pools: Specifies an array of references to backend
address pools of application gateways. A scale set can reference backend address pools of
multiple application gateways. Multiple scale sets cannot use the same application gateway.
:paramtype application_gateway_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword application_security_groups: Specifies an array of references to application security
group.
:paramtype application_security_groups:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword load_balancer_backend_address_pools: Specifies an array of references to backend
address pools of load balancers. A scale set can reference backend address pools of one public
and one internal load balancer. Multiple scale sets cannot use the same load balancer.
:paramtype load_balancer_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword load_balancer_inbound_nat_pools: Specifies an array of references to inbound Nat pools
of the load balancers. A scale set can reference inbound nat pools of one public and one
internal load balancer. Multiple scale sets cannot use the same load balancer.
:paramtype load_balancer_inbound_nat_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
"""
super().__init__(id=id, **kwargs)
self.name = name
self.subnet = subnet
self.primary = primary
self.public_ip_address_configuration = public_ip_address_configuration
self.private_ip_address_version = private_ip_address_version
self.application_gateway_backend_address_pools = application_gateway_backend_address_pools
self.application_security_groups = application_security_groups
self.load_balancer_backend_address_pools = load_balancer_backend_address_pools
self.load_balancer_inbound_nat_pools = load_balancer_inbound_nat_pools
[docs]class VirtualMachineScaleSetIpTag(_serialization.Model):
"""Contains the IP tag associated with the public IP address.
:ivar ip_tag_type: IP tag type. Example: FirstPartyUsage.
:vartype ip_tag_type: str
:ivar tag: IP tag associated with the public IP. Example: SQL, Storage etc.
:vartype tag: str
"""
_attribute_map = {
"ip_tag_type": {"key": "ipTagType", "type": "str"},
"tag": {"key": "tag", "type": "str"},
}
def __init__(self, *, ip_tag_type: Optional[str] = None, tag: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword ip_tag_type: IP tag type. Example: FirstPartyUsage.
:paramtype ip_tag_type: str
:keyword tag: IP tag associated with the public IP. Example: SQL, Storage etc.
:paramtype tag: str
"""
super().__init__(**kwargs)
self.ip_tag_type = ip_tag_type
self.tag = tag
[docs]class VirtualMachineScaleSetListOSUpgradeHistory(_serialization.Model):
"""List of Virtual Machine Scale Set OS Upgrade History operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of OS upgrades performed on the virtual machine scale set. Required.
:vartype value:
list[~azure.mgmt.compute.v2019_03_01.models.UpgradeOperationHistoricalStatusInfo]
:ivar next_link: The uri to fetch the next page of OS Upgrade History. Call ListNext() with
this to fetch the next page of history of upgrades.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[UpgradeOperationHistoricalStatusInfo]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self,
*,
value: List["_models.UpgradeOperationHistoricalStatusInfo"],
next_link: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword value: The list of OS upgrades performed on the virtual machine scale set. Required.
:paramtype value:
list[~azure.mgmt.compute.v2019_03_01.models.UpgradeOperationHistoricalStatusInfo]
:keyword next_link: The uri to fetch the next page of OS Upgrade History. Call ListNext() with
this to fetch the next page of history of upgrades.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetListResult(_serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of virtual machine scale sets. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSet]
:ivar next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext()
with this to fetch the next page of VMSS.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineScaleSet]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachineScaleSet"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of virtual machine scale sets. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSet]
:keyword next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call
ListNext() with this to fetch the next page of VMSS.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetListSkusResult(_serialization.Model):
"""The Virtual Machine Scale Set List Skus operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of skus available for the virtual machine scale set. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetSku]
:ivar next_link: The uri to fetch the next page of Virtual Machine Scale Set Skus. Call
ListNext() with this to fetch the next page of VMSS Skus.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineScaleSetSku]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachineScaleSetSku"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of skus available for the virtual machine scale set. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetSku]
:keyword next_link: The uri to fetch the next page of Virtual Machine Scale Set Skus. Call
ListNext() with this to fetch the next page of VMSS Skus.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetListWithLinkResult(_serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of virtual machine scale sets. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSet]
:ivar next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext()
with this to fetch the next page of Virtual Machine Scale Sets.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineScaleSet]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachineScaleSet"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of virtual machine scale sets. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSet]
:keyword next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call
ListNext() with this to fetch the next page of Virtual Machine Scale Sets.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetManagedDiskParameters(_serialization.Model):
"""Describes the parameters of a ScaleSet managed disk.
:ivar storage_account_type: Specifies the storage account type for the managed disk. Managed OS
disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can
only be used with data disks, it cannot be used with OS Disk. Known values are: "Standard_LRS",
"Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:vartype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
_attribute_map = {
"storage_account_type": {"key": "storageAccountType", "type": "str"},
}
def __init__(
self, *, storage_account_type: Optional[Union[str, "_models.StorageAccountTypes"]] = None, **kwargs: Any
) -> None:
"""
:keyword storage_account_type: Specifies the storage account type for the managed disk. Managed
OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS
can only be used with data disks, it cannot be used with OS Disk. Known values are:
"Standard_LRS", "Premium_LRS", "StandardSSD_LRS", and "UltraSSD_LRS".
:paramtype storage_account_type: str or
~azure.mgmt.compute.v2019_03_01.models.StorageAccountTypes
"""
super().__init__(**kwargs)
self.storage_account_type = storage_account_type
[docs]class VirtualMachineScaleSetNetworkConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's network configurations.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The network configuration name. Required.
:vartype name: str
:ivar primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:vartype primary: bool
:ivar enable_accelerated_networking: Specifies whether the network interface is accelerated
networking-enabled.
:vartype enable_accelerated_networking: bool
:ivar network_security_group: The network security group.
:vartype network_security_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar dns_settings: The dns settings to be applied on the network interfaces.
:vartype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings
:ivar ip_configurations: Specifies the IP configurations of the network interface.
:vartype ip_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIPConfiguration]
:ivar enable_ip_forwarding: Whether IP forwarding enabled on this NIC.
:vartype enable_ip_forwarding: bool
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"primary": {"key": "properties.primary", "type": "bool"},
"enable_accelerated_networking": {"key": "properties.enableAcceleratedNetworking", "type": "bool"},
"network_security_group": {"key": "properties.networkSecurityGroup", "type": "SubResource"},
"dns_settings": {
"key": "properties.dnsSettings",
"type": "VirtualMachineScaleSetNetworkConfigurationDnsSettings",
},
"ip_configurations": {"key": "properties.ipConfigurations", "type": "[VirtualMachineScaleSetIPConfiguration]"},
"enable_ip_forwarding": {"key": "properties.enableIPForwarding", "type": "bool"},
}
def __init__(
self,
*,
name: str,
id: Optional[str] = None, # pylint: disable=redefined-builtin
primary: Optional[bool] = None,
enable_accelerated_networking: Optional[bool] = None,
network_security_group: Optional["_models.SubResource"] = None,
dns_settings: Optional["_models.VirtualMachineScaleSetNetworkConfigurationDnsSettings"] = None,
ip_configurations: Optional[List["_models.VirtualMachineScaleSetIPConfiguration"]] = None,
enable_ip_forwarding: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The network configuration name. Required.
:paramtype name: str
:keyword primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:paramtype primary: bool
:keyword enable_accelerated_networking: Specifies whether the network interface is accelerated
networking-enabled.
:paramtype enable_accelerated_networking: bool
:keyword network_security_group: The network security group.
:paramtype network_security_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword dns_settings: The dns settings to be applied on the network interfaces.
:paramtype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings
:keyword ip_configurations: Specifies the IP configurations of the network interface.
:paramtype ip_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIPConfiguration]
:keyword enable_ip_forwarding: Whether IP forwarding enabled on this NIC.
:paramtype enable_ip_forwarding: bool
"""
super().__init__(id=id, **kwargs)
self.name = name
self.primary = primary
self.enable_accelerated_networking = enable_accelerated_networking
self.network_security_group = network_security_group
self.dns_settings = dns_settings
self.ip_configurations = ip_configurations
self.enable_ip_forwarding = enable_ip_forwarding
[docs]class VirtualMachineScaleSetNetworkConfigurationDnsSettings(_serialization.Model):
"""Describes a virtual machines scale sets network configuration's DNS settings.
:ivar dns_servers: List of DNS servers IP addresses.
:vartype dns_servers: list[str]
"""
_attribute_map = {
"dns_servers": {"key": "dnsServers", "type": "[str]"},
}
def __init__(self, *, dns_servers: Optional[List[str]] = None, **kwargs: Any) -> None:
"""
:keyword dns_servers: List of DNS servers IP addresses.
:paramtype dns_servers: list[str]
"""
super().__init__(**kwargs)
self.dns_servers = dns_servers
[docs]class VirtualMachineScaleSetNetworkProfile(_serialization.Model):
"""Describes a virtual machine scale set network profile.
:ivar health_probe: A reference to a load balancer probe used to determine the health of an
instance in the virtual machine scale set. The reference will be in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
:vartype health_probe: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:ivar network_interface_configurations: The list of network configurations.
:vartype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfiguration]
"""
_attribute_map = {
"health_probe": {"key": "healthProbe", "type": "ApiEntityReference"},
"network_interface_configurations": {
"key": "networkInterfaceConfigurations",
"type": "[VirtualMachineScaleSetNetworkConfiguration]",
},
}
def __init__(
self,
*,
health_probe: Optional["_models.ApiEntityReference"] = None,
network_interface_configurations: Optional[List["_models.VirtualMachineScaleSetNetworkConfiguration"]] = None,
**kwargs: Any
) -> None:
"""
:keyword health_probe: A reference to a load balancer probe used to determine the health of an
instance in the virtual machine scale set. The reference will be in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
:paramtype health_probe: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:keyword network_interface_configurations: The list of network configurations.
:paramtype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfiguration]
"""
super().__init__(**kwargs)
self.health_probe = health_probe
self.network_interface_configurations = network_interface_configurations
[docs]class VirtualMachineScaleSetOSDisk(_serialization.Model):
"""Describes a virtual machine scale set operating system disk.
All required parameters must be populated in order to send to Azure.
:ivar name: The disk name.
:vartype name: str
:ivar caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:vartype write_accelerator_enabled: bool
:ivar create_option: Specifies how the virtual machines in the scale set should be
created.:code:`<br>`:code:`<br>` The only allowed value is: **FromImage** \u2013 This value is
used when you are using an image to create the virtual machine. If you are using a platform
image, you also use the imageReference element described above. If you are using a marketplace
image, you also use the plan element previously described. Required. Known values are:
"FromImage", "Empty", and "Attach".
:vartype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:ivar diff_disk_settings: Specifies the ephemeral disk Settings for the operating system disk
used by the virtual machine scale set.
:vartype diff_disk_settings: ~azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings
:ivar disk_size_gb: Specifies the size of the operating system disk in gigabytes. This element
can be used to overwrite the size of the disk in a virtual machine image.
:code:`<br>`:code:`<br>` This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar os_type: This property allows you to specify the type of the OS that is included in the
disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>` Possible
values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Known
values are: "Windows" and "Linux".
:vartype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:ivar image: Specifies information about the unmanaged user image to base the scale set on.
:vartype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar vhd_containers: Specifies the container urls that are used to store operating system
disks for the scale set.
:vartype vhd_containers: list[str]
:ivar managed_disk: The managed disk parameters.
:vartype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
_validation = {
"create_option": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"caching": {"key": "caching", "type": "str"},
"write_accelerator_enabled": {"key": "writeAcceleratorEnabled", "type": "bool"},
"create_option": {"key": "createOption", "type": "str"},
"diff_disk_settings": {"key": "diffDiskSettings", "type": "DiffDiskSettings"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"os_type": {"key": "osType", "type": "str"},
"image": {"key": "image", "type": "VirtualHardDisk"},
"vhd_containers": {"key": "vhdContainers", "type": "[str]"},
"managed_disk": {"key": "managedDisk", "type": "VirtualMachineScaleSetManagedDiskParameters"},
}
def __init__(
self,
*,
create_option: Union[str, "_models.DiskCreateOptionTypes"],
name: Optional[str] = None,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
write_accelerator_enabled: Optional[bool] = None,
diff_disk_settings: Optional["_models.DiffDiskSettings"] = None,
disk_size_gb: Optional[int] = None,
os_type: Optional[Union[str, "_models.OperatingSystemTypes"]] = None,
image: Optional["_models.VirtualHardDisk"] = None,
vhd_containers: Optional[List[str]] = None,
managed_disk: Optional["_models.VirtualMachineScaleSetManagedDiskParameters"] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The disk name.
:paramtype name: str
:keyword caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:paramtype write_accelerator_enabled: bool
:keyword create_option: Specifies how the virtual machines in the scale set should be
created.:code:`<br>`:code:`<br>` The only allowed value is: **FromImage** \u2013 This value is
used when you are using an image to create the virtual machine. If you are using a platform
image, you also use the imageReference element described above. If you are using a marketplace
image, you also use the plan element previously described. Required. Known values are:
"FromImage", "Empty", and "Attach".
:paramtype create_option: str or ~azure.mgmt.compute.v2019_03_01.models.DiskCreateOptionTypes
:keyword diff_disk_settings: Specifies the ephemeral disk Settings for the operating system
disk used by the virtual machine scale set.
:paramtype diff_disk_settings: ~azure.mgmt.compute.v2019_03_01.models.DiffDiskSettings
:keyword disk_size_gb: Specifies the size of the operating system disk in gigabytes. This
element can be used to overwrite the size of the disk in a virtual machine image.
:code:`<br>`:code:`<br>` This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword os_type: This property allows you to specify the type of the OS that is included in
the disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>`
Possible values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**.
Known values are: "Windows" and "Linux".
:paramtype os_type: str or ~azure.mgmt.compute.v2019_03_01.models.OperatingSystemTypes
:keyword image: Specifies information about the unmanaged user image to base the scale set on.
:paramtype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword vhd_containers: Specifies the container urls that are used to store operating system
disks for the scale set.
:paramtype vhd_containers: list[str]
:keyword managed_disk: The managed disk parameters.
:paramtype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
super().__init__(**kwargs)
self.name = name
self.caching = caching
self.write_accelerator_enabled = write_accelerator_enabled
self.create_option = create_option
self.diff_disk_settings = diff_disk_settings
self.disk_size_gb = disk_size_gb
self.os_type = os_type
self.image = image
self.vhd_containers = vhd_containers
self.managed_disk = managed_disk
[docs]class VirtualMachineScaleSetOSProfile(_serialization.Model):
"""Describes a virtual machine scale set OS profile.
:ivar computer_name_prefix: Specifies the computer name prefix for all of the virtual machines
in the scale set. Computer name prefixes must be 1 to 15 characters long.
:vartype computer_name_prefix: str
:ivar admin_username: Specifies the name of the administrator account. :code:`<br>`:code:`<br>`
**Windows-only restriction:** Cannot end in "." :code:`<br>`:code:`<br>` **Disallowed values:**
"administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1",
"123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest",
"john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2",
"test3", "user4", "user5". :code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character
:code:`<br>`:code:`<br>` **Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>`
**Max-length (Windows):** 20 characters :code:`<br>`:code:`<br>`:code:`<li>` For root access
to the Linux VM, see `Using root privileges on Linux virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_\
:code:`<br>`:code:`<li>` For a list of built-in system users on Linux that should not be used
in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype admin_username: str
:ivar admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` For resetting root password, see `Manage users, SSH, and check or
repair disks on Azure Linux VMs using the VMAccess Extension
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password>`_.
:vartype admin_password: str
:ivar custom_data: Specifies a base-64 encoded string of custom data. The base-64 encoded
string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum
length of the binary array is 65535 bytes. :code:`<br>`:code:`<br>` For using cloud-init for
your VM, see `Using cloud-init to customize a Linux VM during creation
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype custom_data: str
:ivar windows_configuration: Specifies Windows operating system settings on the virtual
machine.
:vartype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:ivar linux_configuration: Specifies the Linux operating system settings on the virtual
machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for
Non-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:vartype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:ivar secrets: Specifies set of certificates that should be installed onto the virtual machines
in the scale set.
:vartype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
"""
_attribute_map = {
"computer_name_prefix": {"key": "computerNamePrefix", "type": "str"},
"admin_username": {"key": "adminUsername", "type": "str"},
"admin_password": {"key": "adminPassword", "type": "str"},
"custom_data": {"key": "customData", "type": "str"},
"windows_configuration": {"key": "windowsConfiguration", "type": "WindowsConfiguration"},
"linux_configuration": {"key": "linuxConfiguration", "type": "LinuxConfiguration"},
"secrets": {"key": "secrets", "type": "[VaultSecretGroup]"},
}
def __init__(
self,
*,
computer_name_prefix: Optional[str] = None,
admin_username: Optional[str] = None,
admin_password: Optional[str] = None,
custom_data: Optional[str] = None,
windows_configuration: Optional["_models.WindowsConfiguration"] = None,
linux_configuration: Optional["_models.LinuxConfiguration"] = None,
secrets: Optional[List["_models.VaultSecretGroup"]] = None,
**kwargs: Any
) -> None:
"""
:keyword computer_name_prefix: Specifies the computer name prefix for all of the virtual
machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
:paramtype computer_name_prefix: str
:keyword admin_username: Specifies the name of the administrator account.
:code:`<br>`:code:`<br>` **Windows-only restriction:** Cannot end in "."
:code:`<br>`:code:`<br>` **Disallowed values:** "administrator", "admin", "user", "user1",
"test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2",
"aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql",
"support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
:code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 20
characters :code:`<br>`:code:`<br>`:code:`<li>` For root access to the Linux VM, see `Using
root privileges on Linux virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_\
:code:`<br>`:code:`<li>` For a list of built-in system users on Linux that should not be used
in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype admin_username: str
:keyword admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` For resetting root password, see `Manage users, SSH, and check or
repair disks on Azure Linux VMs using the VMAccess Extension
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password>`_.
:paramtype admin_password: str
:keyword custom_data: Specifies a base-64 encoded string of custom data. The base-64 encoded
string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum
length of the binary array is 65535 bytes. :code:`<br>`:code:`<br>` For using cloud-init for
your VM, see `Using cloud-init to customize a Linux VM during creation
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype custom_data: str
:keyword windows_configuration: Specifies Windows operating system settings on the virtual
machine.
:paramtype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:keyword linux_configuration: Specifies the Linux operating system settings on the virtual
machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for
Non-Endorsed Distributions
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:paramtype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:keyword secrets: Specifies set of certificates that should be installed onto the virtual
machines in the scale set.
:paramtype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
"""
super().__init__(**kwargs)
self.computer_name_prefix = computer_name_prefix
self.admin_username = admin_username
self.admin_password = admin_password
self.custom_data = custom_data
self.windows_configuration = windows_configuration
self.linux_configuration = linux_configuration
self.secrets = secrets
[docs]class VirtualMachineScaleSetPublicIPAddressConfiguration(_serialization.Model):
"""Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration.
All required parameters must be populated in order to send to Azure.
:ivar name: The publicIP address configuration name. Required.
:vartype name: str
:ivar idle_timeout_in_minutes: The idle timeout of the public IP address.
:vartype idle_timeout_in_minutes: int
:ivar dns_settings: The dns settings to be applied on the publicIP addresses .
:vartype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
:ivar ip_tags: The list of IP tags associated with the public IP address.
:vartype ip_tags: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIpTag]
:ivar public_ip_prefix: The PublicIPPrefix from which to allocate publicIP addresses.
:vartype public_ip_prefix: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"idle_timeout_in_minutes": {"key": "properties.idleTimeoutInMinutes", "type": "int"},
"dns_settings": {
"key": "properties.dnsSettings",
"type": "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings",
},
"ip_tags": {"key": "properties.ipTags", "type": "[VirtualMachineScaleSetIpTag]"},
"public_ip_prefix": {"key": "properties.publicIPPrefix", "type": "SubResource"},
}
def __init__(
self,
*,
name: str,
idle_timeout_in_minutes: Optional[int] = None,
dns_settings: Optional["_models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"] = None,
ip_tags: Optional[List["_models.VirtualMachineScaleSetIpTag"]] = None,
public_ip_prefix: Optional["_models.SubResource"] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The publicIP address configuration name. Required.
:paramtype name: str
:keyword idle_timeout_in_minutes: The idle timeout of the public IP address.
:paramtype idle_timeout_in_minutes: int
:keyword dns_settings: The dns settings to be applied on the publicIP addresses .
:paramtype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
:keyword ip_tags: The list of IP tags associated with the public IP address.
:paramtype ip_tags: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIpTag]
:keyword public_ip_prefix: The PublicIPPrefix from which to allocate publicIP addresses.
:paramtype public_ip_prefix: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(**kwargs)
self.name = name
self.idle_timeout_in_minutes = idle_timeout_in_minutes
self.dns_settings = dns_settings
self.ip_tags = ip_tags
self.public_ip_prefix = public_ip_prefix
[docs]class VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings(_serialization.Model):
"""Describes a virtual machines scale sets network configuration's DNS settings.
All required parameters must be populated in order to send to Azure.
:ivar domain_name_label: The Domain name label.The concatenation of the domain name label and
vm index will be the domain name labels of the PublicIPAddress resources that will be created.
Required.
:vartype domain_name_label: str
"""
_validation = {
"domain_name_label": {"required": True},
}
_attribute_map = {
"domain_name_label": {"key": "domainNameLabel", "type": "str"},
}
def __init__(self, *, domain_name_label: str, **kwargs: Any) -> None:
"""
:keyword domain_name_label: The Domain name label.The concatenation of the domain name label
and vm index will be the domain name labels of the PublicIPAddress resources that will be
created. Required.
:paramtype domain_name_label: str
"""
super().__init__(**kwargs)
self.domain_name_label = domain_name_label
[docs]class VirtualMachineScaleSetVMReimageParameters(VirtualMachineReimageParameters):
"""Describes a Virtual Machine Scale Set VM Reimage Parameters.
:ivar temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This temp
disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:vartype temp_disk: bool
"""
_attribute_map = {
"temp_disk": {"key": "tempDisk", "type": "bool"},
}
def __init__(self, *, temp_disk: Optional[bool] = None, **kwargs: Any) -> None:
"""
:keyword temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This
temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:paramtype temp_disk: bool
"""
super().__init__(temp_disk=temp_disk, **kwargs)
[docs]class VirtualMachineScaleSetReimageParameters(VirtualMachineScaleSetVMReimageParameters):
"""Describes a Virtual Machine Scale Set VM Reimage Parameters.
:ivar temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This temp
disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:vartype temp_disk: bool
:ivar instance_ids: The virtual machine scale set instance ids. Omitting the virtual machine
scale set instance ids will result in the operation being performed on all virtual machines in
the virtual machine scale set.
:vartype instance_ids: list[str]
"""
_attribute_map = {
"temp_disk": {"key": "tempDisk", "type": "bool"},
"instance_ids": {"key": "instanceIds", "type": "[str]"},
}
def __init__(
self, *, temp_disk: Optional[bool] = None, instance_ids: Optional[List[str]] = None, **kwargs: Any
) -> None:
"""
:keyword temp_disk: Specifies whether to reimage temp disk. Default value: false. Note: This
temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
:paramtype temp_disk: bool
:keyword instance_ids: The virtual machine scale set instance ids. Omitting the virtual machine
scale set instance ids will result in the operation being performed on all virtual machines in
the virtual machine scale set.
:paramtype instance_ids: list[str]
"""
super().__init__(temp_disk=temp_disk, **kwargs)
self.instance_ids = instance_ids
[docs]class VirtualMachineScaleSetSku(_serialization.Model):
"""Describes an available virtual machine scale set sku.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar resource_type: The type of resource the sku applies to.
:vartype resource_type: str
:ivar sku: The Sku.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar capacity: Specifies the number of virtual machines in the scale set.
:vartype capacity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetSkuCapacity
"""
_validation = {
"resource_type": {"readonly": True},
"sku": {"readonly": True},
"capacity": {"readonly": True},
}
_attribute_map = {
"resource_type": {"key": "resourceType", "type": "str"},
"sku": {"key": "sku", "type": "Sku"},
"capacity": {"key": "capacity", "type": "VirtualMachineScaleSetSkuCapacity"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.resource_type = None
self.sku = None
self.capacity = None
[docs]class VirtualMachineScaleSetSkuCapacity(_serialization.Model):
"""Describes scaling information of a sku.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar minimum: The minimum capacity.
:vartype minimum: int
:ivar maximum: The maximum capacity that can be set.
:vartype maximum: int
:ivar default_capacity: The default capacity.
:vartype default_capacity: int
:ivar scale_type: The scale type applicable to the sku. Known values are: "Automatic" and
"None".
:vartype scale_type: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetSkuScaleType
"""
_validation = {
"minimum": {"readonly": True},
"maximum": {"readonly": True},
"default_capacity": {"readonly": True},
"scale_type": {"readonly": True},
}
_attribute_map = {
"minimum": {"key": "minimum", "type": "int"},
"maximum": {"key": "maximum", "type": "int"},
"default_capacity": {"key": "defaultCapacity", "type": "int"},
"scale_type": {"key": "scaleType", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.minimum = None
self.maximum = None
self.default_capacity = None
self.scale_type = None
[docs]class VirtualMachineScaleSetStorageProfile(_serialization.Model):
"""Describes a virtual machine scale set storage profile.
:ivar image_reference: Specifies information about the image to use. You can specify
information about platform images, marketplace images, or virtual machine images. This element
is required when you want to use a platform image, marketplace image, or virtual machine image,
but is not used in other creation operations.
:vartype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:ivar os_disk: Specifies information about the operating system disk used by the virtual
machines in the scale set. :code:`<br>`:code:`<br>` For more information about disks, see
`About disks and VHDs for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype os_disk: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetOSDisk
:ivar data_disks: Specifies the parameters that are used to add data disks to the virtual
machines in the scale set. :code:`<br>`:code:`<br>` For more information about disks, see
`About disks and VHDs for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:vartype data_disks:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetDataDisk]
"""
_attribute_map = {
"image_reference": {"key": "imageReference", "type": "ImageReference"},
"os_disk": {"key": "osDisk", "type": "VirtualMachineScaleSetOSDisk"},
"data_disks": {"key": "dataDisks", "type": "[VirtualMachineScaleSetDataDisk]"},
}
def __init__(
self,
*,
image_reference: Optional["_models.ImageReference"] = None,
os_disk: Optional["_models.VirtualMachineScaleSetOSDisk"] = None,
data_disks: Optional[List["_models.VirtualMachineScaleSetDataDisk"]] = None,
**kwargs: Any
) -> None:
"""
:keyword image_reference: Specifies information about the image to use. You can specify
information about platform images, marketplace images, or virtual machine images. This element
is required when you want to use a platform image, marketplace image, or virtual machine image,
but is not used in other creation operations.
:paramtype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:keyword os_disk: Specifies information about the operating system disk used by the virtual
machines in the scale set. :code:`<br>`:code:`<br>` For more information about disks, see
`About disks and VHDs for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype os_disk: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetOSDisk
:keyword data_disks: Specifies the parameters that are used to add data disks to the virtual
machines in the scale set. :code:`<br>`:code:`<br>` For more information about disks, see
`About disks and VHDs for Azure virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:paramtype data_disks:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetDataDisk]
"""
super().__init__(**kwargs)
self.image_reference = image_reference
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class VirtualMachineScaleSetUpdate(UpdateResource): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine Scale Set.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar sku: The virtual machine scale set sku.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar plan: The purchase plan when deploying a virtual machine scale set from VM Marketplace
images.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:ivar identity: The identity of the virtual machine scale set, if configured.
:vartype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentity
:ivar upgrade_policy: The upgrade policy.
:vartype upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.UpgradePolicy
:ivar automatic_repairs_policy: Policy for automatic repairs.
:vartype automatic_repairs_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticRepairsPolicy
:ivar virtual_machine_profile: The virtual machine profile.
:vartype virtual_machine_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateVMProfile
:ivar overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
:vartype overprovision: bool
:ivar do_not_run_extensions_on_overprovisioned_v_ms: When Overprovision is enabled, extensions
are launched only on the requested number of VMs which are finally kept. This property will
hence ensure that the extensions do not run on the extra overprovisioned VMs.
:vartype do_not_run_extensions_on_overprovisioned_v_ms: bool
:ivar single_placement_group: When true this limits the scale set to a single placement group,
of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to
false. However, if singlePlacementGroup is false, it may not be modified to true.
:vartype single_placement_group: bool
:ivar additional_capabilities: Specifies additional capabilities enabled or disabled on the
Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines
have the capability to support attaching managed data disks with UltraSSD_LRS storage account
type.
:vartype additional_capabilities: ~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:ivar scale_in_policy: Specifies the scale-in policy that decides which virtual machines are
chosen for removal when a Virtual Machine Scale Set is scaled-in.
:vartype scale_in_policy: ~azure.mgmt.compute.v2019_03_01.models.ScaleInPolicy
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the virtual machine scale set should be assigned to. :code:`<br>`:code:`<br>`Minimum
api-version: 2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
"plan": {"key": "plan", "type": "Plan"},
"identity": {"key": "identity", "type": "VirtualMachineScaleSetIdentity"},
"upgrade_policy": {"key": "properties.upgradePolicy", "type": "UpgradePolicy"},
"automatic_repairs_policy": {"key": "properties.automaticRepairsPolicy", "type": "AutomaticRepairsPolicy"},
"virtual_machine_profile": {
"key": "properties.virtualMachineProfile",
"type": "VirtualMachineScaleSetUpdateVMProfile",
},
"overprovision": {"key": "properties.overprovision", "type": "bool"},
"do_not_run_extensions_on_overprovisioned_v_ms": {
"key": "properties.doNotRunExtensionsOnOverprovisionedVMs",
"type": "bool",
},
"single_placement_group": {"key": "properties.singlePlacementGroup", "type": "bool"},
"additional_capabilities": {"key": "properties.additionalCapabilities", "type": "AdditionalCapabilities"},
"scale_in_policy": {"key": "properties.scaleInPolicy", "type": "ScaleInPolicy"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
plan: Optional["_models.Plan"] = None,
identity: Optional["_models.VirtualMachineScaleSetIdentity"] = None,
upgrade_policy: Optional["_models.UpgradePolicy"] = None,
automatic_repairs_policy: Optional["_models.AutomaticRepairsPolicy"] = None,
virtual_machine_profile: Optional["_models.VirtualMachineScaleSetUpdateVMProfile"] = None,
overprovision: Optional[bool] = None,
do_not_run_extensions_on_overprovisioned_v_ms: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
additional_capabilities: Optional["_models.AdditionalCapabilities"] = None,
scale_in_policy: Optional["_models.ScaleInPolicy"] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword sku: The virtual machine scale set sku.
:paramtype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:keyword plan: The purchase plan when deploying a virtual machine scale set from VM Marketplace
images.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:keyword identity: The identity of the virtual machine scale set, if configured.
:paramtype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetIdentity
:keyword upgrade_policy: The upgrade policy.
:paramtype upgrade_policy: ~azure.mgmt.compute.v2019_03_01.models.UpgradePolicy
:keyword automatic_repairs_policy: Policy for automatic repairs.
:paramtype automatic_repairs_policy:
~azure.mgmt.compute.v2019_03_01.models.AutomaticRepairsPolicy
:keyword virtual_machine_profile: The virtual machine profile.
:paramtype virtual_machine_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateVMProfile
:keyword overprovision: Specifies whether the Virtual Machine Scale Set should be
overprovisioned.
:paramtype overprovision: bool
:keyword do_not_run_extensions_on_overprovisioned_v_ms: When Overprovision is enabled,
extensions are launched only on the requested number of VMs which are finally kept. This
property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
:paramtype do_not_run_extensions_on_overprovisioned_v_ms: bool
:keyword single_placement_group: When true this limits the scale set to a single placement
group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be
modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
:paramtype single_placement_group: bool
:keyword additional_capabilities: Specifies additional capabilities enabled or disabled on the
Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines
have the capability to support attaching managed data disks with UltraSSD_LRS storage account
type.
:paramtype additional_capabilities:
~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:keyword scale_in_policy: Specifies the scale-in policy that decides which virtual machines are
chosen for removal when a Virtual Machine Scale Set is scaled-in.
:paramtype scale_in_policy: ~azure.mgmt.compute.v2019_03_01.models.ScaleInPolicy
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the virtual machine scale set should be assigned to. :code:`<br>`:code:`<br>`Minimum
api-version: 2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
"""
super().__init__(tags=tags, **kwargs)
self.sku = sku
self.plan = plan
self.identity = identity
self.upgrade_policy = upgrade_policy
self.automatic_repairs_policy = automatic_repairs_policy
self.virtual_machine_profile = virtual_machine_profile
self.overprovision = overprovision
self.do_not_run_extensions_on_overprovisioned_v_ms = do_not_run_extensions_on_overprovisioned_v_ms
self.single_placement_group = single_placement_group
self.additional_capabilities = additional_capabilities
self.scale_in_policy = scale_in_policy
self.proximity_placement_group = proximity_placement_group
[docs]class VirtualMachineScaleSetUpdateIPConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's IP configuration.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The IP configuration name.
:vartype name: str
:ivar subnet: The subnet.
:vartype subnet: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:ivar primary: Specifies the primary IP Configuration in case the network interface has more
than one IP Configuration.
:vartype primary: bool
:ivar public_ip_address_configuration: The publicIPAddressConfiguration.
:vartype public_ip_address_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
:ivar private_ip_address_version: Available from Api-Version 2017-03-30 onwards, it represents
whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible
values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".
:vartype private_ip_address_version: str or ~azure.mgmt.compute.v2019_03_01.models.IPVersion
:ivar application_gateway_backend_address_pools: The application gateway backend address pools.
:vartype application_gateway_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar application_security_groups: Specifies an array of references to application security
group.
:vartype application_security_groups: list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar load_balancer_backend_address_pools: The load balancer backend address pools.
:vartype load_balancer_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:ivar load_balancer_inbound_nat_pools: The load balancer inbound nat pools.
:vartype load_balancer_inbound_nat_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"subnet": {"key": "properties.subnet", "type": "ApiEntityReference"},
"primary": {"key": "properties.primary", "type": "bool"},
"public_ip_address_configuration": {
"key": "properties.publicIPAddressConfiguration",
"type": "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration",
},
"private_ip_address_version": {"key": "properties.privateIPAddressVersion", "type": "str"},
"application_gateway_backend_address_pools": {
"key": "properties.applicationGatewayBackendAddressPools",
"type": "[SubResource]",
},
"application_security_groups": {"key": "properties.applicationSecurityGroups", "type": "[SubResource]"},
"load_balancer_backend_address_pools": {
"key": "properties.loadBalancerBackendAddressPools",
"type": "[SubResource]",
},
"load_balancer_inbound_nat_pools": {"key": "properties.loadBalancerInboundNatPools", "type": "[SubResource]"},
}
def __init__(
self,
*,
id: Optional[str] = None, # pylint: disable=redefined-builtin
name: Optional[str] = None,
subnet: Optional["_models.ApiEntityReference"] = None,
primary: Optional[bool] = None,
public_ip_address_configuration: Optional[
"_models.VirtualMachineScaleSetUpdatePublicIPAddressConfiguration"
] = None,
private_ip_address_version: Optional[Union[str, "_models.IPVersion"]] = None,
application_gateway_backend_address_pools: Optional[List["_models.SubResource"]] = None,
application_security_groups: Optional[List["_models.SubResource"]] = None,
load_balancer_backend_address_pools: Optional[List["_models.SubResource"]] = None,
load_balancer_inbound_nat_pools: Optional[List["_models.SubResource"]] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The IP configuration name.
:paramtype name: str
:keyword subnet: The subnet.
:paramtype subnet: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:keyword primary: Specifies the primary IP Configuration in case the network interface has more
than one IP Configuration.
:paramtype primary: bool
:keyword public_ip_address_configuration: The publicIPAddressConfiguration.
:paramtype public_ip_address_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
:keyword private_ip_address_version: Available from Api-Version 2017-03-30 onwards, it
represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.
Possible values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".
:paramtype private_ip_address_version: str or ~azure.mgmt.compute.v2019_03_01.models.IPVersion
:keyword application_gateway_backend_address_pools: The application gateway backend address
pools.
:paramtype application_gateway_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword application_security_groups: Specifies an array of references to application security
group.
:paramtype application_security_groups:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword load_balancer_backend_address_pools: The load balancer backend address pools.
:paramtype load_balancer_backend_address_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
:keyword load_balancer_inbound_nat_pools: The load balancer inbound nat pools.
:paramtype load_balancer_inbound_nat_pools:
list[~azure.mgmt.compute.v2019_03_01.models.SubResource]
"""
super().__init__(id=id, **kwargs)
self.name = name
self.subnet = subnet
self.primary = primary
self.public_ip_address_configuration = public_ip_address_configuration
self.private_ip_address_version = private_ip_address_version
self.application_gateway_backend_address_pools = application_gateway_backend_address_pools
self.application_security_groups = application_security_groups
self.load_balancer_backend_address_pools = load_balancer_backend_address_pools
self.load_balancer_inbound_nat_pools = load_balancer_inbound_nat_pools
[docs]class VirtualMachineScaleSetUpdateNetworkConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's network configurations.
:ivar id: Resource Id.
:vartype id: str
:ivar name: The network configuration name.
:vartype name: str
:ivar primary: Whether this is a primary NIC on a virtual machine.
:vartype primary: bool
:ivar enable_accelerated_networking: Specifies whether the network interface is accelerated
networking-enabled.
:vartype enable_accelerated_networking: bool
:ivar network_security_group: The network security group.
:vartype network_security_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar dns_settings: The dns settings to be applied on the network interfaces.
:vartype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings
:ivar ip_configurations: The virtual machine scale set IP Configuration.
:vartype ip_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateIPConfiguration]
:ivar enable_ip_forwarding: Whether IP forwarding enabled on this NIC.
:vartype enable_ip_forwarding: bool
"""
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"primary": {"key": "properties.primary", "type": "bool"},
"enable_accelerated_networking": {"key": "properties.enableAcceleratedNetworking", "type": "bool"},
"network_security_group": {"key": "properties.networkSecurityGroup", "type": "SubResource"},
"dns_settings": {
"key": "properties.dnsSettings",
"type": "VirtualMachineScaleSetNetworkConfigurationDnsSettings",
},
"ip_configurations": {
"key": "properties.ipConfigurations",
"type": "[VirtualMachineScaleSetUpdateIPConfiguration]",
},
"enable_ip_forwarding": {"key": "properties.enableIPForwarding", "type": "bool"},
}
def __init__(
self,
*,
id: Optional[str] = None, # pylint: disable=redefined-builtin
name: Optional[str] = None,
primary: Optional[bool] = None,
enable_accelerated_networking: Optional[bool] = None,
network_security_group: Optional["_models.SubResource"] = None,
dns_settings: Optional["_models.VirtualMachineScaleSetNetworkConfigurationDnsSettings"] = None,
ip_configurations: Optional[List["_models.VirtualMachineScaleSetUpdateIPConfiguration"]] = None,
enable_ip_forwarding: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword id: Resource Id.
:paramtype id: str
:keyword name: The network configuration name.
:paramtype name: str
:keyword primary: Whether this is a primary NIC on a virtual machine.
:paramtype primary: bool
:keyword enable_accelerated_networking: Specifies whether the network interface is accelerated
networking-enabled.
:paramtype enable_accelerated_networking: bool
:keyword network_security_group: The network security group.
:paramtype network_security_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword dns_settings: The dns settings to be applied on the network interfaces.
:paramtype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings
:keyword ip_configurations: The virtual machine scale set IP Configuration.
:paramtype ip_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateIPConfiguration]
:keyword enable_ip_forwarding: Whether IP forwarding enabled on this NIC.
:paramtype enable_ip_forwarding: bool
"""
super().__init__(id=id, **kwargs)
self.name = name
self.primary = primary
self.enable_accelerated_networking = enable_accelerated_networking
self.network_security_group = network_security_group
self.dns_settings = dns_settings
self.ip_configurations = ip_configurations
self.enable_ip_forwarding = enable_ip_forwarding
[docs]class VirtualMachineScaleSetUpdateNetworkProfile(_serialization.Model):
"""Describes a virtual machine scale set network profile.
:ivar health_probe: A reference to a load balancer probe used to determine the health of an
instance in the virtual machine scale set. The reference will be in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
:vartype health_probe: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:ivar network_interface_configurations: The list of network configurations.
:vartype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateNetworkConfiguration]
"""
_attribute_map = {
"health_probe": {"key": "healthProbe", "type": "ApiEntityReference"},
"network_interface_configurations": {
"key": "networkInterfaceConfigurations",
"type": "[VirtualMachineScaleSetUpdateNetworkConfiguration]",
},
}
def __init__(
self,
*,
health_probe: Optional["_models.ApiEntityReference"] = None,
network_interface_configurations: Optional[
List["_models.VirtualMachineScaleSetUpdateNetworkConfiguration"]
] = None,
**kwargs: Any
) -> None:
"""
:keyword health_probe: A reference to a load balancer probe used to determine the health of an
instance in the virtual machine scale set. The reference will be in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
:paramtype health_probe: ~azure.mgmt.compute.v2019_03_01.models.ApiEntityReference
:keyword network_interface_configurations: The list of network configurations.
:paramtype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateNetworkConfiguration]
"""
super().__init__(**kwargs)
self.health_probe = health_probe
self.network_interface_configurations = network_interface_configurations
[docs]class VirtualMachineScaleSetUpdateOSDisk(_serialization.Model):
"""Describes virtual machine scale set operating system disk Update Object. This should be used
for Updating VMSS OS Disk.
:ivar caching: The caching type. Known values are: "None", "ReadOnly", and "ReadWrite".
:vartype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:ivar write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:vartype write_accelerator_enabled: bool
:ivar disk_size_gb: Specifies the size of the operating system disk in gigabytes. This element
can be used to overwrite the size of the disk in a virtual machine image.
:code:`<br>`:code:`<br>` This value cannot be larger than 1023 GB.
:vartype disk_size_gb: int
:ivar image: The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before
using it to attach to the Virtual Machine. If SourceImage is provided, the destination
VirtualHardDisk should not exist.
:vartype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:ivar vhd_containers: The list of virtual hard disk container uris.
:vartype vhd_containers: list[str]
:ivar managed_disk: The managed disk parameters.
:vartype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
_attribute_map = {
"caching": {"key": "caching", "type": "str"},
"write_accelerator_enabled": {"key": "writeAcceleratorEnabled", "type": "bool"},
"disk_size_gb": {"key": "diskSizeGB", "type": "int"},
"image": {"key": "image", "type": "VirtualHardDisk"},
"vhd_containers": {"key": "vhdContainers", "type": "[str]"},
"managed_disk": {"key": "managedDisk", "type": "VirtualMachineScaleSetManagedDiskParameters"},
}
def __init__(
self,
*,
caching: Optional[Union[str, "_models.CachingTypes"]] = None,
write_accelerator_enabled: Optional[bool] = None,
disk_size_gb: Optional[int] = None,
image: Optional["_models.VirtualHardDisk"] = None,
vhd_containers: Optional[List[str]] = None,
managed_disk: Optional["_models.VirtualMachineScaleSetManagedDiskParameters"] = None,
**kwargs: Any
) -> None:
"""
:keyword caching: The caching type. Known values are: "None", "ReadOnly", and "ReadWrite".
:paramtype caching: str or ~azure.mgmt.compute.v2019_03_01.models.CachingTypes
:keyword write_accelerator_enabled: Specifies whether writeAccelerator should be enabled or
disabled on the disk.
:paramtype write_accelerator_enabled: bool
:keyword disk_size_gb: Specifies the size of the operating system disk in gigabytes. This
element can be used to overwrite the size of the disk in a virtual machine image.
:code:`<br>`:code:`<br>` This value cannot be larger than 1023 GB.
:paramtype disk_size_gb: int
:keyword image: The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied
before using it to attach to the Virtual Machine. If SourceImage is provided, the destination
VirtualHardDisk should not exist.
:paramtype image: ~azure.mgmt.compute.v2019_03_01.models.VirtualHardDisk
:keyword vhd_containers: The list of virtual hard disk container uris.
:paramtype vhd_containers: list[str]
:keyword managed_disk: The managed disk parameters.
:paramtype managed_disk:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetManagedDiskParameters
"""
super().__init__(**kwargs)
self.caching = caching
self.write_accelerator_enabled = write_accelerator_enabled
self.disk_size_gb = disk_size_gb
self.image = image
self.vhd_containers = vhd_containers
self.managed_disk = managed_disk
[docs]class VirtualMachineScaleSetUpdateOSProfile(_serialization.Model):
"""Describes a virtual machine scale set OS profile.
:ivar custom_data: A base-64 encoded string of custom data.
:vartype custom_data: str
:ivar windows_configuration: The Windows Configuration of the OS profile.
:vartype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:ivar linux_configuration: The Linux Configuration of the OS profile.
:vartype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:ivar secrets: The List of certificates for addition to the VM.
:vartype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
"""
_attribute_map = {
"custom_data": {"key": "customData", "type": "str"},
"windows_configuration": {"key": "windowsConfiguration", "type": "WindowsConfiguration"},
"linux_configuration": {"key": "linuxConfiguration", "type": "LinuxConfiguration"},
"secrets": {"key": "secrets", "type": "[VaultSecretGroup]"},
}
def __init__(
self,
*,
custom_data: Optional[str] = None,
windows_configuration: Optional["_models.WindowsConfiguration"] = None,
linux_configuration: Optional["_models.LinuxConfiguration"] = None,
secrets: Optional[List["_models.VaultSecretGroup"]] = None,
**kwargs: Any
) -> None:
"""
:keyword custom_data: A base-64 encoded string of custom data.
:paramtype custom_data: str
:keyword windows_configuration: The Windows Configuration of the OS profile.
:paramtype windows_configuration: ~azure.mgmt.compute.v2019_03_01.models.WindowsConfiguration
:keyword linux_configuration: The Linux Configuration of the OS profile.
:paramtype linux_configuration: ~azure.mgmt.compute.v2019_03_01.models.LinuxConfiguration
:keyword secrets: The List of certificates for addition to the VM.
:paramtype secrets: list[~azure.mgmt.compute.v2019_03_01.models.VaultSecretGroup]
"""
super().__init__(**kwargs)
self.custom_data = custom_data
self.windows_configuration = windows_configuration
self.linux_configuration = linux_configuration
self.secrets = secrets
[docs]class VirtualMachineScaleSetUpdatePublicIPAddressConfiguration(_serialization.Model):
"""Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration.
:ivar name: The publicIP address configuration name.
:vartype name: str
:ivar idle_timeout_in_minutes: The idle timeout of the public IP address.
:vartype idle_timeout_in_minutes: int
:ivar dns_settings: The dns settings to be applied on the publicIP addresses .
:vartype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"idle_timeout_in_minutes": {"key": "properties.idleTimeoutInMinutes", "type": "int"},
"dns_settings": {
"key": "properties.dnsSettings",
"type": "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings",
},
}
def __init__(
self,
*,
name: Optional[str] = None,
idle_timeout_in_minutes: Optional[int] = None,
dns_settings: Optional["_models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings"] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The publicIP address configuration name.
:paramtype name: str
:keyword idle_timeout_in_minutes: The idle timeout of the public IP address.
:paramtype idle_timeout_in_minutes: int
:keyword dns_settings: The dns settings to be applied on the publicIP addresses .
:paramtype dns_settings:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
"""
super().__init__(**kwargs)
self.name = name
self.idle_timeout_in_minutes = idle_timeout_in_minutes
self.dns_settings = dns_settings
[docs]class VirtualMachineScaleSetUpdateStorageProfile(_serialization.Model):
"""Describes a virtual machine scale set storage profile.
:ivar image_reference: The image reference.
:vartype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:ivar os_disk: The OS disk.
:vartype os_disk: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateOSDisk
:ivar data_disks: The data disks.
:vartype data_disks:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetDataDisk]
"""
_attribute_map = {
"image_reference": {"key": "imageReference", "type": "ImageReference"},
"os_disk": {"key": "osDisk", "type": "VirtualMachineScaleSetUpdateOSDisk"},
"data_disks": {"key": "dataDisks", "type": "[VirtualMachineScaleSetDataDisk]"},
}
def __init__(
self,
*,
image_reference: Optional["_models.ImageReference"] = None,
os_disk: Optional["_models.VirtualMachineScaleSetUpdateOSDisk"] = None,
data_disks: Optional[List["_models.VirtualMachineScaleSetDataDisk"]] = None,
**kwargs: Any
) -> None:
"""
:keyword image_reference: The image reference.
:paramtype image_reference: ~azure.mgmt.compute.v2019_03_01.models.ImageReference
:keyword os_disk: The OS disk.
:paramtype os_disk: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateOSDisk
:keyword data_disks: The data disks.
:paramtype data_disks:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetDataDisk]
"""
super().__init__(**kwargs)
self.image_reference = image_reference
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class VirtualMachineScaleSetUpdateVMProfile(_serialization.Model):
"""Describes a virtual machine scale set virtual machine profile.
:ivar os_profile: The virtual machine scale set OS profile.
:vartype os_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateOSProfile
:ivar storage_profile: The virtual machine scale set storage profile.
:vartype storage_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateStorageProfile
:ivar network_profile: The virtual machine scale set network profile.
:vartype network_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateNetworkProfile
:ivar diagnostics_profile: The virtual machine scale set diagnostics profile.
:vartype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:ivar extension_profile: The virtual machine scale set extension profile.
:vartype extension_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtensionProfile
:ivar license_type: The license type, which is for bring your own license scenario.
:vartype license_type: str
:ivar billing_profile: Specifies the billing related details of a low priority VMSS.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:vartype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:ivar scheduled_events_profile: Specifies Scheduled Event related configurations.
:vartype scheduled_events_profile:
~azure.mgmt.compute.v2019_03_01.models.ScheduledEventsProfile
"""
_attribute_map = {
"os_profile": {"key": "osProfile", "type": "VirtualMachineScaleSetUpdateOSProfile"},
"storage_profile": {"key": "storageProfile", "type": "VirtualMachineScaleSetUpdateStorageProfile"},
"network_profile": {"key": "networkProfile", "type": "VirtualMachineScaleSetUpdateNetworkProfile"},
"diagnostics_profile": {"key": "diagnosticsProfile", "type": "DiagnosticsProfile"},
"extension_profile": {"key": "extensionProfile", "type": "VirtualMachineScaleSetExtensionProfile"},
"license_type": {"key": "licenseType", "type": "str"},
"billing_profile": {"key": "billingProfile", "type": "BillingProfile"},
"scheduled_events_profile": {"key": "scheduledEventsProfile", "type": "ScheduledEventsProfile"},
}
def __init__(
self,
*,
os_profile: Optional["_models.VirtualMachineScaleSetUpdateOSProfile"] = None,
storage_profile: Optional["_models.VirtualMachineScaleSetUpdateStorageProfile"] = None,
network_profile: Optional["_models.VirtualMachineScaleSetUpdateNetworkProfile"] = None,
diagnostics_profile: Optional["_models.DiagnosticsProfile"] = None,
extension_profile: Optional["_models.VirtualMachineScaleSetExtensionProfile"] = None,
license_type: Optional[str] = None,
billing_profile: Optional["_models.BillingProfile"] = None,
scheduled_events_profile: Optional["_models.ScheduledEventsProfile"] = None,
**kwargs: Any
) -> None:
"""
:keyword os_profile: The virtual machine scale set OS profile.
:paramtype os_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateOSProfile
:keyword storage_profile: The virtual machine scale set storage profile.
:paramtype storage_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateStorageProfile
:keyword network_profile: The virtual machine scale set network profile.
:paramtype network_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetUpdateNetworkProfile
:keyword diagnostics_profile: The virtual machine scale set diagnostics profile.
:paramtype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:keyword extension_profile: The virtual machine scale set extension profile.
:paramtype extension_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtensionProfile
:keyword license_type: The license type, which is for bring your own license scenario.
:paramtype license_type: str
:keyword billing_profile: Specifies the billing related details of a low priority VMSS.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:paramtype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:keyword scheduled_events_profile: Specifies Scheduled Event related configurations.
:paramtype scheduled_events_profile:
~azure.mgmt.compute.v2019_03_01.models.ScheduledEventsProfile
"""
super().__init__(**kwargs)
self.os_profile = os_profile
self.storage_profile = storage_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.extension_profile = extension_profile
self.license_type = license_type
self.billing_profile = billing_profile
self.scheduled_events_profile = scheduled_events_profile
[docs]class VirtualMachineScaleSetVM(Resource): # pylint: disable=too-many-instance-attributes
"""Describes a virtual machine scale set virtual machine.
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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar location: Resource location. Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar instance_id: The virtual machine instance ID.
:vartype instance_id: str
:ivar sku: The virtual machine SKU.
:vartype sku: ~azure.mgmt.compute.v2019_03_01.models.Sku
:ivar plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:ivar resources: The virtual machine child extension resources.
:vartype resources: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtension]
:ivar zones: The virtual machine zones.
:vartype zones: list[str]
:ivar latest_model_applied: Specifies whether the latest model has been applied to the virtual
machine.
:vartype latest_model_applied: bool
:ivar vm_id: Azure VM unique ID.
:vartype vm_id: str
:ivar instance_view: The virtual machine instance view.
:vartype instance_view:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMInstanceView
:ivar hardware_profile: Specifies the hardware settings for the virtual machine.
:vartype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:ivar additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine in the scale set. For instance: whether the virtual machine has the capability
to support attaching managed data disks with UltraSSD_LRS storage account type.
:vartype additional_capabilities: ~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:ivar os_profile: Specifies the operating system settings for the virtual machine.
:vartype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:ivar network_profile: Specifies the network interfaces of the virtual machine.
:vartype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:ivar network_profile_configuration: Specifies the network profile configuration of the virtual
machine.
:vartype network_profile_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMNetworkProfileConfiguration
:ivar diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:vartype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:ivar availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.
:vartype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype license_type: str
:ivar model_definition_applied: Specifies whether the model applied to the virtual machine is
the model of the virtual machine scale set or the customized model for the virtual machine.
:vartype model_definition_applied: str
:ivar protection_policy: Specifies the protection policy of the virtual machine.
:vartype protection_policy:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMProtectionPolicy
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"instance_id": {"readonly": True},
"sku": {"readonly": True},
"resources": {"readonly": True},
"zones": {"readonly": True},
"latest_model_applied": {"readonly": True},
"vm_id": {"readonly": True},
"instance_view": {"readonly": True},
"provisioning_state": {"readonly": True},
"model_definition_applied": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"instance_id": {"key": "instanceId", "type": "str"},
"sku": {"key": "sku", "type": "Sku"},
"plan": {"key": "plan", "type": "Plan"},
"resources": {"key": "resources", "type": "[VirtualMachineExtension]"},
"zones": {"key": "zones", "type": "[str]"},
"latest_model_applied": {"key": "properties.latestModelApplied", "type": "bool"},
"vm_id": {"key": "properties.vmId", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "VirtualMachineScaleSetVMInstanceView"},
"hardware_profile": {"key": "properties.hardwareProfile", "type": "HardwareProfile"},
"storage_profile": {"key": "properties.storageProfile", "type": "StorageProfile"},
"additional_capabilities": {"key": "properties.additionalCapabilities", "type": "AdditionalCapabilities"},
"os_profile": {"key": "properties.osProfile", "type": "OSProfile"},
"network_profile": {"key": "properties.networkProfile", "type": "NetworkProfile"},
"network_profile_configuration": {
"key": "properties.networkProfileConfiguration",
"type": "VirtualMachineScaleSetVMNetworkProfileConfiguration",
},
"diagnostics_profile": {"key": "properties.diagnosticsProfile", "type": "DiagnosticsProfile"},
"availability_set": {"key": "properties.availabilitySet", "type": "SubResource"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"license_type": {"key": "properties.licenseType", "type": "str"},
"model_definition_applied": {"key": "properties.modelDefinitionApplied", "type": "str"},
"protection_policy": {"key": "properties.protectionPolicy", "type": "VirtualMachineScaleSetVMProtectionPolicy"},
}
def __init__( # pylint: disable=too-many-locals
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
plan: Optional["_models.Plan"] = None,
hardware_profile: Optional["_models.HardwareProfile"] = None,
storage_profile: Optional["_models.StorageProfile"] = None,
additional_capabilities: Optional["_models.AdditionalCapabilities"] = None,
os_profile: Optional["_models.OSProfile"] = None,
network_profile: Optional["_models.NetworkProfile"] = None,
network_profile_configuration: Optional["_models.VirtualMachineScaleSetVMNetworkProfileConfiguration"] = None,
diagnostics_profile: Optional["_models.DiagnosticsProfile"] = None,
availability_set: Optional["_models.SubResource"] = None,
license_type: Optional[str] = None,
protection_policy: Optional["_models.VirtualMachineScaleSetVMProtectionPolicy"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Resource location. Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:keyword hardware_profile: Specifies the hardware settings for the virtual machine.
:paramtype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:keyword additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine in the scale set. For instance: whether the virtual machine has the capability
to support attaching managed data disks with UltraSSD_LRS storage account type.
:paramtype additional_capabilities:
~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:keyword os_profile: Specifies the operating system settings for the virtual machine.
:paramtype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:keyword network_profile: Specifies the network interfaces of the virtual machine.
:paramtype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:keyword network_profile_configuration: Specifies the network profile configuration of the
virtual machine.
:paramtype network_profile_configuration:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMNetworkProfileConfiguration
:keyword diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:paramtype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:keyword availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.
:paramtype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype license_type: str
:keyword protection_policy: Specifies the protection policy of the virtual machine.
:paramtype protection_policy:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVMProtectionPolicy
"""
super().__init__(location=location, tags=tags, **kwargs)
self.instance_id = None
self.sku = None
self.plan = plan
self.resources = None
self.zones = None
self.latest_model_applied = None
self.vm_id = None
self.instance_view = None
self.hardware_profile = hardware_profile
self.storage_profile = storage_profile
self.additional_capabilities = additional_capabilities
self.os_profile = os_profile
self.network_profile = network_profile
self.network_profile_configuration = network_profile_configuration
self.diagnostics_profile = diagnostics_profile
self.availability_set = availability_set
self.provisioning_state = None
self.license_type = license_type
self.model_definition_applied = None
self.protection_policy = protection_policy
[docs]class VirtualMachineScaleSetVMExtensionsSummary(_serialization.Model):
"""Extensions summary for virtual machines of a virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: The extension name.
:vartype name: str
:ivar statuses_summary: The extensions information.
:vartype statuses_summary:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineStatusCodeCount]
"""
_validation = {
"name": {"readonly": True},
"statuses_summary": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"statuses_summary": {"key": "statusesSummary", "type": "[VirtualMachineStatusCodeCount]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.name = None
self.statuses_summary = None
[docs]class VirtualMachineScaleSetVMInstanceIDs(_serialization.Model):
"""Specifies a list of virtual machine instance IDs from the VM scale set.
:ivar instance_ids: The virtual machine scale set instance ids. Omitting the virtual machine
scale set instance ids will result in the operation being performed on all virtual machines in
the virtual machine scale set.
:vartype instance_ids: list[str]
"""
_attribute_map = {
"instance_ids": {"key": "instanceIds", "type": "[str]"},
}
def __init__(self, *, instance_ids: Optional[List[str]] = None, **kwargs: Any) -> None:
"""
:keyword instance_ids: The virtual machine scale set instance ids. Omitting the virtual machine
scale set instance ids will result in the operation being performed on all virtual machines in
the virtual machine scale set.
:paramtype instance_ids: list[str]
"""
super().__init__(**kwargs)
self.instance_ids = instance_ids
[docs]class VirtualMachineScaleSetVMInstanceRequiredIDs(_serialization.Model):
"""Specifies a list of virtual machine instance IDs from the VM scale set.
All required parameters must be populated in order to send to Azure.
:ivar instance_ids: The virtual machine scale set instance ids. Required.
:vartype instance_ids: list[str]
"""
_validation = {
"instance_ids": {"required": True},
}
_attribute_map = {
"instance_ids": {"key": "instanceIds", "type": "[str]"},
}
def __init__(self, *, instance_ids: List[str], **kwargs: Any) -> None:
"""
:keyword instance_ids: The virtual machine scale set instance ids. Required.
:paramtype instance_ids: list[str]
"""
super().__init__(**kwargs)
self.instance_ids = instance_ids
[docs]class VirtualMachineScaleSetVMInstanceView(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""The instance view of a virtual machine scale set VM.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar platform_update_domain: The Update Domain count.
:vartype platform_update_domain: int
:ivar platform_fault_domain: The Fault Domain count.
:vartype platform_fault_domain: int
:ivar rdp_thumb_print: The Remote desktop certificate thumbprint.
:vartype rdp_thumb_print: str
:ivar vm_agent: The VM Agent running on the virtual machine.
:vartype vm_agent: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineAgentInstanceView
:ivar maintenance_redeploy_status: The Maintenance Operation status on the virtual machine.
:vartype maintenance_redeploy_status:
~azure.mgmt.compute.v2019_03_01.models.MaintenanceRedeployStatus
:ivar disks: The disks information.
:vartype disks: list[~azure.mgmt.compute.v2019_03_01.models.DiskInstanceView]
:ivar extensions: The extensions information.
:vartype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView]
:ivar vm_health: The health status for the VM.
:vartype vm_health: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineHealthStatus
:ivar boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:vartype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnosticsInstanceView
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
:ivar placement_group_id: The placement group in which the VM is running. If the VM is
deallocated it will not have a placementGroupId.
:vartype placement_group_id: str
"""
_validation = {
"vm_health": {"readonly": True},
}
_attribute_map = {
"platform_update_domain": {"key": "platformUpdateDomain", "type": "int"},
"platform_fault_domain": {"key": "platformFaultDomain", "type": "int"},
"rdp_thumb_print": {"key": "rdpThumbPrint", "type": "str"},
"vm_agent": {"key": "vmAgent", "type": "VirtualMachineAgentInstanceView"},
"maintenance_redeploy_status": {"key": "maintenanceRedeployStatus", "type": "MaintenanceRedeployStatus"},
"disks": {"key": "disks", "type": "[DiskInstanceView]"},
"extensions": {"key": "extensions", "type": "[VirtualMachineExtensionInstanceView]"},
"vm_health": {"key": "vmHealth", "type": "VirtualMachineHealthStatus"},
"boot_diagnostics": {"key": "bootDiagnostics", "type": "BootDiagnosticsInstanceView"},
"statuses": {"key": "statuses", "type": "[InstanceViewStatus]"},
"placement_group_id": {"key": "placementGroupId", "type": "str"},
}
def __init__(
self,
*,
platform_update_domain: Optional[int] = None,
platform_fault_domain: Optional[int] = None,
rdp_thumb_print: Optional[str] = None,
vm_agent: Optional["_models.VirtualMachineAgentInstanceView"] = None,
maintenance_redeploy_status: Optional["_models.MaintenanceRedeployStatus"] = None,
disks: Optional[List["_models.DiskInstanceView"]] = None,
extensions: Optional[List["_models.VirtualMachineExtensionInstanceView"]] = None,
boot_diagnostics: Optional["_models.BootDiagnosticsInstanceView"] = None,
statuses: Optional[List["_models.InstanceViewStatus"]] = None,
placement_group_id: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword platform_update_domain: The Update Domain count.
:paramtype platform_update_domain: int
:keyword platform_fault_domain: The Fault Domain count.
:paramtype platform_fault_domain: int
:keyword rdp_thumb_print: The Remote desktop certificate thumbprint.
:paramtype rdp_thumb_print: str
:keyword vm_agent: The VM Agent running on the virtual machine.
:paramtype vm_agent: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineAgentInstanceView
:keyword maintenance_redeploy_status: The Maintenance Operation status on the virtual machine.
:paramtype maintenance_redeploy_status:
~azure.mgmt.compute.v2019_03_01.models.MaintenanceRedeployStatus
:keyword disks: The disks information.
:paramtype disks: list[~azure.mgmt.compute.v2019_03_01.models.DiskInstanceView]
:keyword extensions: The extensions information.
:paramtype extensions:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineExtensionInstanceView]
:keyword boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:paramtype boot_diagnostics: ~azure.mgmt.compute.v2019_03_01.models.BootDiagnosticsInstanceView
:keyword statuses: The resource status information.
:paramtype statuses: list[~azure.mgmt.compute.v2019_03_01.models.InstanceViewStatus]
:keyword placement_group_id: The placement group in which the VM is running. If the VM is
deallocated it will not have a placementGroupId.
:paramtype placement_group_id: str
"""
super().__init__(**kwargs)
self.platform_update_domain = platform_update_domain
self.platform_fault_domain = platform_fault_domain
self.rdp_thumb_print = rdp_thumb_print
self.vm_agent = vm_agent
self.maintenance_redeploy_status = maintenance_redeploy_status
self.disks = disks
self.extensions = extensions
self.vm_health = None
self.boot_diagnostics = boot_diagnostics
self.statuses = statuses
self.placement_group_id = placement_group_id
[docs]class VirtualMachineScaleSetVMListResult(_serialization.Model):
"""The List Virtual Machine Scale Set VMs operation response.
All required parameters must be populated in order to send to Azure.
:ivar value: The list of virtual machine scale sets VMs. Required.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVM]
:ivar next_link: The uri to fetch the next page of Virtual Machine Scale Set VMs. Call
ListNext() with this to fetch the next page of VMSS VMs.
:vartype next_link: str
"""
_validation = {
"value": {"required": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineScaleSetVM]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(
self, *, value: List["_models.VirtualMachineScaleSetVM"], next_link: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword value: The list of virtual machine scale sets VMs. Required.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetVM]
:keyword next_link: The uri to fetch the next page of Virtual Machine Scale Set VMs. Call
ListNext() with this to fetch the next page of VMSS VMs.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetVMNetworkProfileConfiguration(_serialization.Model):
"""Describes a virtual machine scale set VM network profile.
:ivar network_interface_configurations: The list of network configurations.
:vartype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfiguration]
"""
_attribute_map = {
"network_interface_configurations": {
"key": "networkInterfaceConfigurations",
"type": "[VirtualMachineScaleSetNetworkConfiguration]",
},
}
def __init__(
self,
*,
network_interface_configurations: Optional[List["_models.VirtualMachineScaleSetNetworkConfiguration"]] = None,
**kwargs: Any
) -> None:
"""
:keyword network_interface_configurations: The list of network configurations.
:paramtype network_interface_configurations:
list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkConfiguration]
"""
super().__init__(**kwargs)
self.network_interface_configurations = network_interface_configurations
[docs]class VirtualMachineScaleSetVMProfile(_serialization.Model):
"""Describes a virtual machine scale set virtual machine profile.
:ivar os_profile: Specifies the operating system settings for the virtual machines in the scale
set.
:vartype os_profile: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetOSProfile
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetStorageProfile
:ivar network_profile: Specifies properties of the network interfaces of the virtual machines
in the scale set.
:vartype network_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkProfile
:ivar diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:vartype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:ivar extension_profile: Specifies a collection of settings for extensions installed on virtual
machines in the scale set.
:vartype extension_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtensionProfile
:ivar license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype license_type: str
:ivar priority: Specifies the priority for the virtual machines in the scale set.
:code:`<br>`:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: "Regular",
"Low", and "Spot".
:vartype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:ivar eviction_policy: Specifies the eviction policy for virtual machines in a Azure Spot scale
set. :code:`<br>`:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are:
"Deallocate" and "Delete".
:vartype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:ivar billing_profile: Specifies the billing related details of a Azure Spot VMSS.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:vartype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:ivar scheduled_events_profile: Specifies Scheduled Event related configurations.
:vartype scheduled_events_profile:
~azure.mgmt.compute.v2019_03_01.models.ScheduledEventsProfile
"""
_attribute_map = {
"os_profile": {"key": "osProfile", "type": "VirtualMachineScaleSetOSProfile"},
"storage_profile": {"key": "storageProfile", "type": "VirtualMachineScaleSetStorageProfile"},
"network_profile": {"key": "networkProfile", "type": "VirtualMachineScaleSetNetworkProfile"},
"diagnostics_profile": {"key": "diagnosticsProfile", "type": "DiagnosticsProfile"},
"extension_profile": {"key": "extensionProfile", "type": "VirtualMachineScaleSetExtensionProfile"},
"license_type": {"key": "licenseType", "type": "str"},
"priority": {"key": "priority", "type": "str"},
"eviction_policy": {"key": "evictionPolicy", "type": "str"},
"billing_profile": {"key": "billingProfile", "type": "BillingProfile"},
"scheduled_events_profile": {"key": "scheduledEventsProfile", "type": "ScheduledEventsProfile"},
}
def __init__(
self,
*,
os_profile: Optional["_models.VirtualMachineScaleSetOSProfile"] = None,
storage_profile: Optional["_models.VirtualMachineScaleSetStorageProfile"] = None,
network_profile: Optional["_models.VirtualMachineScaleSetNetworkProfile"] = None,
diagnostics_profile: Optional["_models.DiagnosticsProfile"] = None,
extension_profile: Optional["_models.VirtualMachineScaleSetExtensionProfile"] = None,
license_type: Optional[str] = None,
priority: Optional[Union[str, "_models.VirtualMachinePriorityTypes"]] = None,
eviction_policy: Optional[Union[str, "_models.VirtualMachineEvictionPolicyTypes"]] = None,
billing_profile: Optional["_models.BillingProfile"] = None,
scheduled_events_profile: Optional["_models.ScheduledEventsProfile"] = None,
**kwargs: Any
) -> None:
"""
:keyword os_profile: Specifies the operating system settings for the virtual machines in the
scale set.
:paramtype os_profile: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetOSProfile
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetStorageProfile
:keyword network_profile: Specifies properties of the network interfaces of the virtual
machines in the scale set.
:paramtype network_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetNetworkProfile
:keyword diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:paramtype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:keyword extension_profile: Specifies a collection of settings for extensions installed on
virtual machines in the scale set.
:paramtype extension_profile:
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineScaleSetExtensionProfile
:keyword license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype license_type: str
:keyword priority: Specifies the priority for the virtual machines in the scale set.
:code:`<br>`:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: "Regular",
"Low", and "Spot".
:paramtype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:keyword eviction_policy: Specifies the eviction policy for virtual machines in a Azure Spot
scale set. :code:`<br>`:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are:
"Deallocate" and "Delete".
:paramtype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:keyword billing_profile: Specifies the billing related details of a Azure Spot VMSS.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:paramtype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:keyword scheduled_events_profile: Specifies Scheduled Event related configurations.
:paramtype scheduled_events_profile:
~azure.mgmt.compute.v2019_03_01.models.ScheduledEventsProfile
"""
super().__init__(**kwargs)
self.os_profile = os_profile
self.storage_profile = storage_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.extension_profile = extension_profile
self.license_type = license_type
self.priority = priority
self.eviction_policy = eviction_policy
self.billing_profile = billing_profile
self.scheduled_events_profile = scheduled_events_profile
[docs]class VirtualMachineScaleSetVMProtectionPolicy(_serialization.Model):
"""The protection policy of a virtual machine scale set VM.
:ivar protect_from_scale_in: Indicates that the virtual machine scale set VM shouldn't be
considered for deletion during a scale-in operation.
:vartype protect_from_scale_in: bool
:ivar protect_from_scale_set_actions: Indicates that model updates or actions (including
scale-in) initiated on the virtual machine scale set should not be applied to the virtual
machine scale set VM.
:vartype protect_from_scale_set_actions: bool
"""
_attribute_map = {
"protect_from_scale_in": {"key": "protectFromScaleIn", "type": "bool"},
"protect_from_scale_set_actions": {"key": "protectFromScaleSetActions", "type": "bool"},
}
def __init__(
self,
*,
protect_from_scale_in: Optional[bool] = None,
protect_from_scale_set_actions: Optional[bool] = None,
**kwargs: Any
) -> None:
"""
:keyword protect_from_scale_in: Indicates that the virtual machine scale set VM shouldn't be
considered for deletion during a scale-in operation.
:paramtype protect_from_scale_in: bool
:keyword protect_from_scale_set_actions: Indicates that model updates or actions (including
scale-in) initiated on the virtual machine scale set should not be applied to the virtual
machine scale set VM.
:paramtype protect_from_scale_set_actions: bool
"""
super().__init__(**kwargs)
self.protect_from_scale_in = protect_from_scale_in
self.protect_from_scale_set_actions = protect_from_scale_set_actions
[docs]class VirtualMachineSize(_serialization.Model):
"""Describes the properties of a VM size.
:ivar name: The name of the virtual machine size.
:vartype name: str
:ivar number_of_cores: The number of cores supported by the virtual machine size.
:vartype number_of_cores: int
:ivar os_disk_size_in_mb: The OS disk size, in MB, allowed by the virtual machine size.
:vartype os_disk_size_in_mb: int
:ivar resource_disk_size_in_mb: The resource disk size, in MB, allowed by the virtual machine
size.
:vartype resource_disk_size_in_mb: int
:ivar memory_in_mb: The amount of memory, in MB, supported by the virtual machine size.
:vartype memory_in_mb: int
:ivar max_data_disk_count: The maximum number of data disks that can be attached to the virtual
machine size.
:vartype max_data_disk_count: int
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"number_of_cores": {"key": "numberOfCores", "type": "int"},
"os_disk_size_in_mb": {"key": "osDiskSizeInMB", "type": "int"},
"resource_disk_size_in_mb": {"key": "resourceDiskSizeInMB", "type": "int"},
"memory_in_mb": {"key": "memoryInMB", "type": "int"},
"max_data_disk_count": {"key": "maxDataDiskCount", "type": "int"},
}
def __init__(
self,
*,
name: Optional[str] = None,
number_of_cores: Optional[int] = None,
os_disk_size_in_mb: Optional[int] = None,
resource_disk_size_in_mb: Optional[int] = None,
memory_in_mb: Optional[int] = None,
max_data_disk_count: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword name: The name of the virtual machine size.
:paramtype name: str
:keyword number_of_cores: The number of cores supported by the virtual machine size.
:paramtype number_of_cores: int
:keyword os_disk_size_in_mb: The OS disk size, in MB, allowed by the virtual machine size.
:paramtype os_disk_size_in_mb: int
:keyword resource_disk_size_in_mb: The resource disk size, in MB, allowed by the virtual
machine size.
:paramtype resource_disk_size_in_mb: int
:keyword memory_in_mb: The amount of memory, in MB, supported by the virtual machine size.
:paramtype memory_in_mb: int
:keyword max_data_disk_count: The maximum number of data disks that can be attached to the
virtual machine size.
:paramtype max_data_disk_count: int
"""
super().__init__(**kwargs)
self.name = name
self.number_of_cores = number_of_cores
self.os_disk_size_in_mb = os_disk_size_in_mb
self.resource_disk_size_in_mb = resource_disk_size_in_mb
self.memory_in_mb = memory_in_mb
self.max_data_disk_count = max_data_disk_count
[docs]class VirtualMachineSizeListResult(_serialization.Model):
"""The List Virtual Machine operation response.
:ivar value: The list of virtual machine sizes.
:vartype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSize]
"""
_attribute_map = {
"value": {"key": "value", "type": "[VirtualMachineSize]"},
}
def __init__(self, *, value: Optional[List["_models.VirtualMachineSize"]] = None, **kwargs: Any) -> None:
"""
:keyword value: The list of virtual machine sizes.
:paramtype value: list[~azure.mgmt.compute.v2019_03_01.models.VirtualMachineSize]
"""
super().__init__(**kwargs)
self.value = value
[docs]class VirtualMachineStatusCodeCount(_serialization.Model):
"""The status code and count of the virtual machine scale set instance view status summary.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The instance view status code.
:vartype code: str
:ivar count: The number of instances having a particular status code.
:vartype count: int
"""
_validation = {
"code": {"readonly": True},
"count": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"count": {"key": "count", "type": "int"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.code = None
self.count = None
[docs]class VirtualMachineUpdate(UpdateResource): # pylint: disable=too-many-instance-attributes
"""Describes a Virtual Machine Update.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:vartype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:ivar identity: The identity of the virtual machine, if configured.
:vartype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineIdentity
:ivar zones: The virtual machine zones.
:vartype zones: list[str]
:ivar hardware_profile: Specifies the hardware settings for the virtual machine.
:vartype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:ivar storage_profile: Specifies the storage settings for the virtual machine disks.
:vartype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:ivar additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine.
:vartype additional_capabilities: ~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:ivar os_profile: Specifies the operating system settings for the virtual machine.
:vartype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:ivar network_profile: Specifies the network interfaces of the virtual machine.
:vartype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:ivar diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:vartype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:ivar availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set. :code:`<br>`:code:`<br>`This
property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
:vartype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar virtual_machine_scale_set: Specifies information about the virtual machine scale set that
the virtual machine should be assigned to. Virtual machines specified in the same virtual
machine scale set are allocated to different nodes to maximize availability. Currently, a VM
can only be added to virtual machine scale set at creation time. An existing VM cannot be added
to a virtual machine scale set. :code:`<br>`:code:`<br>`This property cannot exist along with a
non-null properties.availabilitySet reference. :code:`<br>`:code:`<br>`Minimum api‐version:
2019‐03‐01.
:vartype virtual_machine_scale_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar proximity_placement_group: Specifies information about the proximity placement group that
the virtual machine should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:vartype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar priority: Specifies the priority for the virtual machine. :code:`<br>`:code:`<br>`Minimum
api-version: 2019-03-01. Known values are: "Regular", "Low", and "Spot".
:vartype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:ivar eviction_policy: Specifies the eviction policy for the Azure Spot virtual machine. Only
supported value is 'Deallocate'. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01. Known
values are: "Deallocate" and "Delete".
:vartype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:ivar billing_profile: Specifies the billing related details of a Azure Spot virtual machine.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:vartype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:ivar host: Specifies information about the dedicated host that the virtual machine resides in.
:code:`<br>`:code:`<br>`Minimum api-version: 2018-10-01.
:vartype host: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The virtual machine instance view.
:vartype instance_view: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineInstanceView
:ivar license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:vartype license_type: str
:ivar vm_id: Specifies the VM unique ID which is a 128-bits identifier that is encoded and
stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
:vartype vm_id: str
"""
_validation = {
"provisioning_state": {"readonly": True},
"instance_view": {"readonly": True},
"vm_id": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"plan": {"key": "plan", "type": "Plan"},
"identity": {"key": "identity", "type": "VirtualMachineIdentity"},
"zones": {"key": "zones", "type": "[str]"},
"hardware_profile": {"key": "properties.hardwareProfile", "type": "HardwareProfile"},
"storage_profile": {"key": "properties.storageProfile", "type": "StorageProfile"},
"additional_capabilities": {"key": "properties.additionalCapabilities", "type": "AdditionalCapabilities"},
"os_profile": {"key": "properties.osProfile", "type": "OSProfile"},
"network_profile": {"key": "properties.networkProfile", "type": "NetworkProfile"},
"diagnostics_profile": {"key": "properties.diagnosticsProfile", "type": "DiagnosticsProfile"},
"availability_set": {"key": "properties.availabilitySet", "type": "SubResource"},
"virtual_machine_scale_set": {"key": "properties.virtualMachineScaleSet", "type": "SubResource"},
"proximity_placement_group": {"key": "properties.proximityPlacementGroup", "type": "SubResource"},
"priority": {"key": "properties.priority", "type": "str"},
"eviction_policy": {"key": "properties.evictionPolicy", "type": "str"},
"billing_profile": {"key": "properties.billingProfile", "type": "BillingProfile"},
"host": {"key": "properties.host", "type": "SubResource"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"instance_view": {"key": "properties.instanceView", "type": "VirtualMachineInstanceView"},
"license_type": {"key": "properties.licenseType", "type": "str"},
"vm_id": {"key": "properties.vmId", "type": "str"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
plan: Optional["_models.Plan"] = None,
identity: Optional["_models.VirtualMachineIdentity"] = None,
zones: Optional[List[str]] = None,
hardware_profile: Optional["_models.HardwareProfile"] = None,
storage_profile: Optional["_models.StorageProfile"] = None,
additional_capabilities: Optional["_models.AdditionalCapabilities"] = None,
os_profile: Optional["_models.OSProfile"] = None,
network_profile: Optional["_models.NetworkProfile"] = None,
diagnostics_profile: Optional["_models.DiagnosticsProfile"] = None,
availability_set: Optional["_models.SubResource"] = None,
virtual_machine_scale_set: Optional["_models.SubResource"] = None,
proximity_placement_group: Optional["_models.SubResource"] = None,
priority: Optional[Union[str, "_models.VirtualMachinePriorityTypes"]] = None,
eviction_policy: Optional[Union[str, "_models.VirtualMachineEvictionPolicyTypes"]] = None,
billing_profile: Optional["_models.BillingProfile"] = None,
host: Optional["_models.SubResource"] = None,
license_type: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword plan: Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images. Before you can use a marketplace
image from an API, you must enable the image for programmatic use. In the Azure portal, find
the marketplace image that you want to use and then click **Want to deploy programmatically,
Get Started ->**. Enter any required information and then click **Save**.
:paramtype plan: ~azure.mgmt.compute.v2019_03_01.models.Plan
:keyword identity: The identity of the virtual machine, if configured.
:paramtype identity: ~azure.mgmt.compute.v2019_03_01.models.VirtualMachineIdentity
:keyword zones: The virtual machine zones.
:paramtype zones: list[str]
:keyword hardware_profile: Specifies the hardware settings for the virtual machine.
:paramtype hardware_profile: ~azure.mgmt.compute.v2019_03_01.models.HardwareProfile
:keyword storage_profile: Specifies the storage settings for the virtual machine disks.
:paramtype storage_profile: ~azure.mgmt.compute.v2019_03_01.models.StorageProfile
:keyword additional_capabilities: Specifies additional capabilities enabled or disabled on the
virtual machine.
:paramtype additional_capabilities:
~azure.mgmt.compute.v2019_03_01.models.AdditionalCapabilities
:keyword os_profile: Specifies the operating system settings for the virtual machine.
:paramtype os_profile: ~azure.mgmt.compute.v2019_03_01.models.OSProfile
:keyword network_profile: Specifies the network interfaces of the virtual machine.
:paramtype network_profile: ~azure.mgmt.compute.v2019_03_01.models.NetworkProfile
:keyword diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:paramtype diagnostics_profile: ~azure.mgmt.compute.v2019_03_01.models.DiagnosticsProfile
:keyword availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned
maintenance for virtual machines in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set. :code:`<br>`:code:`<br>`This
property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
:paramtype availability_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword virtual_machine_scale_set: Specifies information about the virtual machine scale set
that the virtual machine should be assigned to. Virtual machines specified in the same virtual
machine scale set are allocated to different nodes to maximize availability. Currently, a VM
can only be added to virtual machine scale set at creation time. An existing VM cannot be added
to a virtual machine scale set. :code:`<br>`:code:`<br>`This property cannot exist along with a
non-null properties.availabilitySet reference. :code:`<br>`:code:`<br>`Minimum api‐version:
2019‐03‐01.
:paramtype virtual_machine_scale_set: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword proximity_placement_group: Specifies information about the proximity placement group
that the virtual machine should be assigned to. :code:`<br>`:code:`<br>`Minimum api-version:
2018-04-01.
:paramtype proximity_placement_group: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword priority: Specifies the priority for the virtual machine.
:code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01. Known values are: "Regular", "Low",
and "Spot".
:paramtype priority: str or ~azure.mgmt.compute.v2019_03_01.models.VirtualMachinePriorityTypes
:keyword eviction_policy: Specifies the eviction policy for the Azure Spot virtual machine.
Only supported value is 'Deallocate'. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
Known values are: "Deallocate" and "Delete".
:paramtype eviction_policy: str or
~azure.mgmt.compute.v2019_03_01.models.VirtualMachineEvictionPolicyTypes
:keyword billing_profile: Specifies the billing related details of a Azure Spot virtual
machine. :code:`<br>`:code:`<br>`Minimum api-version: 2019-03-01.
:paramtype billing_profile: ~azure.mgmt.compute.v2019_03_01.models.BillingProfile
:keyword host: Specifies information about the dedicated host that the virtual machine resides
in. :code:`<br>`:code:`<br>`Minimum api-version: 2018-10-01.
:paramtype host: ~azure.mgmt.compute.v2019_03_01.models.SubResource
:keyword license_type: Specifies that the image or disk that is being used was licensed
on-premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:paramtype license_type: str
"""
super().__init__(tags=tags, **kwargs)
self.plan = plan
self.identity = identity
self.zones = zones
self.hardware_profile = hardware_profile
self.storage_profile = storage_profile
self.additional_capabilities = additional_capabilities
self.os_profile = os_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.availability_set = availability_set
self.virtual_machine_scale_set = virtual_machine_scale_set
self.proximity_placement_group = proximity_placement_group
self.priority = priority
self.eviction_policy = eviction_policy
self.billing_profile = billing_profile
self.host = host
self.provisioning_state = None
self.instance_view = None
self.license_type = license_type
self.vm_id = None
[docs]class WindowsConfiguration(_serialization.Model):
"""Specifies Windows operating system settings on the virtual machine.
:ivar provision_vm_agent: Indicates whether virtual machine agent should be provisioned on the
virtual machine. :code:`<br>`:code:`<br>` When this property is not specified in the request
body, default behavior is to set it to true. This will ensure that VM Agent is installed on
the VM so that extensions can be added to the VM later.
:vartype provision_vm_agent: bool
:ivar enable_automatic_updates: Indicates whether Automatic Updates is enabled for the Windows
virtual machine. Default value is true. :code:`<br>`:code:`<br>` For virtual machine scale
sets, this property can be updated and updates will take effect on OS reprovisioning.
:vartype enable_automatic_updates: bool
:ivar time_zone: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".
:vartype time_zone: str
:ivar additional_unattend_content: Specifies additional base-64 encoded XML formatted
information that can be included in the Unattend.xml file, which is used by Windows Setup.
:vartype additional_unattend_content:
list[~azure.mgmt.compute.v2019_03_01.models.AdditionalUnattendContent]
:ivar win_rm: Specifies the Windows Remote Management listeners. This enables remote Windows
PowerShell.
:vartype win_rm: ~azure.mgmt.compute.v2019_03_01.models.WinRMConfiguration
"""
_attribute_map = {
"provision_vm_agent": {"key": "provisionVMAgent", "type": "bool"},
"enable_automatic_updates": {"key": "enableAutomaticUpdates", "type": "bool"},
"time_zone": {"key": "timeZone", "type": "str"},
"additional_unattend_content": {"key": "additionalUnattendContent", "type": "[AdditionalUnattendContent]"},
"win_rm": {"key": "winRM", "type": "WinRMConfiguration"},
}
def __init__(
self,
*,
provision_vm_agent: Optional[bool] = None,
enable_automatic_updates: Optional[bool] = None,
time_zone: Optional[str] = None,
additional_unattend_content: Optional[List["_models.AdditionalUnattendContent"]] = None,
win_rm: Optional["_models.WinRMConfiguration"] = None,
**kwargs: Any
) -> None:
"""
:keyword provision_vm_agent: Indicates whether virtual machine agent should be provisioned on
the virtual machine. :code:`<br>`:code:`<br>` When this property is not specified in the
request body, default behavior is to set it to true. This will ensure that VM Agent is
installed on the VM so that extensions can be added to the VM later.
:paramtype provision_vm_agent: bool
:keyword enable_automatic_updates: Indicates whether Automatic Updates is enabled for the
Windows virtual machine. Default value is true. :code:`<br>`:code:`<br>` For virtual machine
scale sets, this property can be updated and updates will take effect on OS reprovisioning.
:paramtype enable_automatic_updates: bool
:keyword time_zone: Specifies the time zone of the virtual machine. e.g. "Pacific Standard
Time".
:paramtype time_zone: str
:keyword additional_unattend_content: Specifies additional base-64 encoded XML formatted
information that can be included in the Unattend.xml file, which is used by Windows Setup.
:paramtype additional_unattend_content:
list[~azure.mgmt.compute.v2019_03_01.models.AdditionalUnattendContent]
:keyword win_rm: Specifies the Windows Remote Management listeners. This enables remote Windows
PowerShell.
:paramtype win_rm: ~azure.mgmt.compute.v2019_03_01.models.WinRMConfiguration
"""
super().__init__(**kwargs)
self.provision_vm_agent = provision_vm_agent
self.enable_automatic_updates = enable_automatic_updates
self.time_zone = time_zone
self.additional_unattend_content = additional_unattend_content
self.win_rm = win_rm
[docs]class WinRMConfiguration(_serialization.Model):
"""Describes Windows Remote Management configuration of the VM.
:ivar listeners: The list of Windows Remote Management listeners.
:vartype listeners: list[~azure.mgmt.compute.v2019_03_01.models.WinRMListener]
"""
_attribute_map = {
"listeners": {"key": "listeners", "type": "[WinRMListener]"},
}
def __init__(self, *, listeners: Optional[List["_models.WinRMListener"]] = None, **kwargs: Any) -> None:
"""
:keyword listeners: The list of Windows Remote Management listeners.
:paramtype listeners: list[~azure.mgmt.compute.v2019_03_01.models.WinRMListener]
"""
super().__init__(**kwargs)
self.listeners = listeners
[docs]class WinRMListener(_serialization.Model):
"""Describes Protocol and thumbprint of Windows Remote Management listener.
:ivar protocol: Specifies the protocol of listener. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`\ **http** :code:`<br>`:code:`<br>` **https**. Known values are: "Http" and
"Https".
:vartype protocol: str or ~azure.mgmt.compute.v2019_03_01.models.ProtocolTypes
:ivar certificate_url: This is the URL of a certificate that has been uploaded to Key Vault as
a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>`
"data":":code:`<Base64-encoded-certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>`
"password":":code:`<pfx-file-password>`":code:`<br>`}.
:vartype certificate_url: str
"""
_attribute_map = {
"protocol": {"key": "protocol", "type": "str"},
"certificate_url": {"key": "certificateUrl", "type": "str"},
}
def __init__(
self,
*,
protocol: Optional[Union[str, "_models.ProtocolTypes"]] = None,
certificate_url: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword protocol: Specifies the protocol of listener. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`\ **http** :code:`<br>`:code:`<br>` **https**. Known values are: "Http" and
"Https".
:paramtype protocol: str or ~azure.mgmt.compute.v2019_03_01.models.ProtocolTypes
:keyword certificate_url: This is the URL of a certificate that has been uploaded to Key Vault
as a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>`
"data":":code:`<Base64-encoded-certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>`
"password":":code:`<pfx-file-password>`":code:`<br>`}.
:paramtype certificate_url: str
"""
super().__init__(**kwargs)
self.protocol = protocol
self.certificate_url = certificate_url