azure.mgmt.compute.v2018_10_01.models module¶
-
class
azure.mgmt.compute.v2018_10_01.models.
AdditionalCapabilities
(*, ultra_ssd_enabled: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Enables or disables a capability on the virtual machine or virtual machine scale set.
- Variables
ultra_ssd_enabled (bool) – 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.
- Keyword Arguments
ultra_ssd_enabled (bool) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
AdditionalUnattendContent
(*, 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)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
pass_name (str) – The pass name. Currently, the only allowable value is OobeSystem. Default value is “OobeSystem”.
component_name (str) – The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Default value is “Microsoft-Windows-Shell-Setup”.
setting_name (str or SettingNames) – Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Known values are: “AutoLogon” and “FirstLogonCommands”.
content (str) – 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.
- Keyword Arguments
pass_name (str) – The pass name. Currently, the only allowable value is OobeSystem. Default value is “OobeSystem”.
component_name (str) – The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Default value is “Microsoft-Windows-Shell-Setup”.
setting_name (str or SettingNames) – Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Known values are: “AutoLogon” and “FirstLogonCommands”.
content (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
ApiEntityReference
(*, id: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The API entity reference.
-
class
azure.mgmt.compute.v2018_10_01.models.
ApiError
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Api error.
- Variables
details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
target (str) – The target of the particular error.
message (str) – The error message.
- Keyword Arguments
details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.
-
class
azure.mgmt.compute.v2018_10_01.models.
ApiErrorBase
(*, code: Optional[str] = None, target: Optional[str] = None, message: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Api error base.
-
class
azure.mgmt.compute.v2018_10_01.models.
AutomaticOSUpgradePolicy
(*, enable_automatic_os_upgrade: Optional[bool] = None, disable_automatic_rollback: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The configuration parameters used for performing automatic OS upgrade.
- Variables
enable_automatic_os_upgrade (bool) – 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. If this is set to true for Windows based scale sets, recommendation is to set enableAutomaticUpdates to false.
disable_automatic_rollback (bool) – Whether OS image rollback feature should be disabled. Default value is false.
- Keyword Arguments
enable_automatic_os_upgrade (bool) –
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. If this is set to true for Windows based scale sets, recommendation is to set enableAutomaticUpdates to false.
disable_automatic_rollback (bool) – Whether OS image rollback feature should be disabled. Default value is false.
-
class
azure.mgmt.compute.v2018_10_01.models.
AutomaticOSUpgradeProperties
(*, automatic_os_upgrade_supported: bool, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes automatic OS upgrade properties on the image.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2018_10_01.models.
AutomaticRepairsPolicy
(*, enabled: Optional[bool] = None, grace_period: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
- Variables
enabled (bool) – Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
grace_period (str) – 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).
- Keyword Arguments
enabled (bool) – Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
grace_period (str) – 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).
-
class
azure.mgmt.compute.v2018_10_01.models.
AvailabilitySet
(*, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.Resource
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
sku (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’.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
location (str) – Resource location. Required.
sku (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’.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
-
class
azure.mgmt.compute.v2018_10_01.models.
AvailabilitySetListResult
(*, value: List[_models.AvailabilitySet], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Availability Set operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[AvailabilitySet]) – The list of availability sets. Required.
next_link (str) – The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
- Keyword Arguments
value (list[AvailabilitySet]) – The list of availability sets. Required.
next_link (str) – The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
-
class
azure.mgmt.compute.v2018_10_01.models.
AvailabilitySetSkuTypes
(value)[source]¶ -
Specifies the sku of an Availability Set. Use ‘Aligned’ for virtual machines with managed disks and ‘Classic’ for virtual machines with unmanaged disks. Default value is ‘Classic’.
-
ALIGNED
= 'Aligned'¶
-
CLASSIC
= 'Classic'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
AvailabilitySetUpdate
(*, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
sku (Sku) – Sku of the availability set.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
sku (Sku) – Sku of the availability set.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
-
class
azure.mgmt.compute.v2018_10_01.models.
BootDiagnostics
(*, enabled: Optional[bool] = None, storage_uri: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
BootDiagnosticsInstanceView
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
console_screenshot_blob_uri (str) – The console screenshot blob URI.
serial_console_log_blob_uri (str) – The Linux serial console log blob Uri.
status (InstanceViewStatus) – The boot diagnostics status information for the VM.
<br>
<br>
NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.
-
class
azure.mgmt.compute.v2018_10_01.models.
CachingTypes
(value)[source]¶ -
Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage.-
NONE
= 'None'¶
-
READ_ONLY
= 'ReadOnly'¶
-
READ_WRITE
= 'ReadWrite'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
ComputeOperationListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Compute Operation operation response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[ComputeOperationValue]) – The list of compute operations.
-
class
azure.mgmt.compute.v2018_10_01.models.
ComputeOperationValue
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
origin (str) – The origin of the compute operation.
name (str) – The name of the compute operation.
operation (str) – The display name of the compute operation.
resource (str) – The display name of the resource the operation applies to.
description (str) – The description of the operation.
provider (str) – The resource provider for the operation.
-
class
azure.mgmt.compute.v2018_10_01.models.
DataDisk
(*, 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a data disk.
All required parameters must be populated in order to send to Azure.
- Variables
lun (int) – 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.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine should be created.:code:<br>
<br>
Possible values are:<br>
<br>
Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br>
FromImage – 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”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (ManagedDiskParameters) – The managed disk parameters.
- Keyword Arguments
lun (int) – 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.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine should be created.:code:<br>
<br>
Possible values are:<br>
<br>
Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br>
FromImage – 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”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (ManagedDiskParameters) – The managed disk parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
DataDiskImage
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Contains the data disk images information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
lun (int) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
DiagnosticsProfile
(*, boot_diagnostics: Optional[_models.BootDiagnostics] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.- Variables
boot_diagnostics (BootDiagnostics) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.- Keyword Arguments
boot_diagnostics (BootDiagnostics) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.
-
class
azure.mgmt.compute.v2018_10_01.models.
DiffDiskOptions
(value)[source]¶ -
Specifies the ephemeral disk option for operating system disk.
-
LOCAL
= 'Local'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
DiffDiskSettings
(*, option: Optional[Union[str, _models.DiffDiskOptions]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the parameters of ephemeral disk settings that can be specified for operating system disk.
<br>
<br>
NOTE: The ephemeral disk settings can only be specified for managed disk.- Variables
option (str or DiffDiskOptions) – Specifies the ephemeral disk settings for operating system disk. “Local”
- Keyword Arguments
option (str or DiffDiskOptions) – Specifies the ephemeral disk settings for operating system disk. “Local”
-
class
azure.mgmt.compute.v2018_10_01.models.
DiskCreateOptionTypes
(value)[source]¶ -
Specifies how the virtual machine should be created.:code:<br>
<br>
Possible values are:<br>
<br>
Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br>
FromImage – 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.-
ATTACH
= 'Attach'¶
-
EMPTY
= 'Empty'¶
-
FROM_IMAGE
= 'FromImage'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
DiskEncryptionSettings
(*, disk_encryption_key: Optional[_models.KeyVaultSecretReference] = None, key_encryption_key: Optional[_models.KeyVaultKeyReference] = None, enabled: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a Encryption Settings for a Disk.
- Variables
disk_encryption_key (KeyVaultSecretReference) – Specifies the location of the disk encryption key, which is a Key Vault Secret.
key_encryption_key (KeyVaultKeyReference) – Specifies the location of the key encryption key in Key Vault.
enabled (bool) – Specifies whether disk encryption should be enabled on the virtual machine.
- Keyword Arguments
disk_encryption_key (KeyVaultSecretReference) – Specifies the location of the disk encryption key, which is a Key Vault Secret.
key_encryption_key (KeyVaultKeyReference) – Specifies the location of the key encryption key in Key Vault.
enabled (bool) – Specifies whether disk encryption should be enabled on the virtual machine.
-
class
azure.mgmt.compute.v2018_10_01.models.
DiskInstanceView
(*, name: Optional[str] = None, encryption_settings: Optional[List[_models.DiskEncryptionSettings]] = None, statuses: Optional[List[_models.InstanceViewStatus]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The instance view of the disk.
- Variables
name (str) – The disk name.
encryption_settings (list[DiskEncryptionSettings]) – Specifies the encryption settings for the OS Disk.
<br>
<br>
Minimum api-version: 2015-06-15.statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
name (str) – The disk name.
encryption_settings (list[DiskEncryptionSettings]) – Specifies the encryption settings for the OS Disk.
<br>
<br>
Minimum api-version: 2015-06-15.statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2018_10_01.models.
HardwareProfile
(*, vm_size: Optional[Union[str, _models.VirtualMachineSizeTypes]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the hardware settings for the virtual machine.
- Variables
vm_size (str or VirtualMachineSizeTypes) – Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.
<br>
<br>
The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:<br>
<br>
List all available virtual machine sizes in an availability set<br>
<br>
List all available virtual machine sizes in a region<br>
<br>
List all available virtual machine sizes for resizing. 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”.- Keyword Arguments
vm_size (str or VirtualMachineSizeTypes) –
Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.
<br>
<br>
The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:<br>
<br>
List all available virtual machine sizes in an availability set<br>
<br>
List all available virtual machine sizes in a region<br>
<br>
List all available virtual machine sizes for resizing. 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”.
-
class
azure.mgmt.compute.v2018_10_01.models.
IPVersion
(value)[source]¶ -
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’.
-
I_PV4
= 'IPv4'¶
-
I_PV6
= 'IPv6'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
Image
(*, location: str, tags: Optional[Dict[str, str]] = None, source_virtual_machine: Optional[_models.SubResource] = None, storage_profile: Optional[_models.ImageStorageProfile] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
provisioning_state (str) – The provisioning state.
- Keyword Arguments
location (str) – Resource location. Required.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageDataDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a data disk.
All required parameters must be populated in order to send to Azure.
- Variables
lun (int) – 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.
snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.storage_account_type (str or StorageAccountTypes) – 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”.
- Keyword Arguments
lun (int) – 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.
snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.storage_account_type (str or StorageAccountTypes) – 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”.
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageListResult
(*, value: List[_models.Image], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Image operation response.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageOSDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes an Operating System disk.
All required parameters must be populated in order to send to Azure.
- Variables
os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Required. Known values are: “Windows” and “Linux”.os_state (str or OperatingSystemStateTypes) – The OS State. Required. Known values are: “Generalized” and “Specialized”.
snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.storage_account_type (str or StorageAccountTypes) – 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”.
- Keyword Arguments
os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Required. Known values are: “Windows” and “Linux”.os_state (str or OperatingSystemStateTypes) – The OS State. Required. Known values are: “Generalized” and “Specialized”.
snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.storage_account_type (str or StorageAccountTypes) – 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”.
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageReference
(*, id: Optional[str] = None, publisher: Optional[str] = None, offer: Optional[str] = None, sku: Optional[str] = None, version: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
publisher (str) – The image publisher.
offer (str) – Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku (str) – The image SKU.
version (str) – 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.
- Keyword Arguments
id (str) – Resource Id.
publisher (str) – The image publisher.
offer (str) – Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku (str) – The image SKU.
version (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageStorageProfile
(*, os_disk: Optional[_models.ImageOSDisk] = None, data_disks: Optional[List[_models.ImageDataDisk]] = None, zone_resilient: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a storage profile.
- Variables
os_disk (ImageOSDisk) – Specifies information about the operating system disk used by the virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.data_disks (list[ImageDataDisk]) –
Specifies the parameters that are used to add a data disk to a virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.zone_resilient (bool) – 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).
- Keyword Arguments
os_disk (ImageOSDisk) –
Specifies information about the operating system disk used by the virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.data_disks (list[ImageDataDisk]) –
Specifies the parameters that are used to add a data disk to a virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.zone_resilient (bool) – 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).
-
class
azure.mgmt.compute.v2018_10_01.models.
ImageUpdate
(*, tags: Optional[Dict[str, str]] = None, source_virtual_machine: Optional[_models.SubResource] = None, storage_profile: Optional[_models.ImageStorageProfile] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
provisioning_state (str) – The provisioning state.
- Keyword Arguments
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
-
class
azure.mgmt.compute.v2018_10_01.models.
InnerError
(*, exceptiontype: Optional[str] = None, errordetail: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Inner error details.
-
class
azure.mgmt.compute.v2018_10_01.models.
InstanceViewStatus
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Instance view status.
- Variables
level (str or StatusLevelTypes) – The level code. Known values are: “Info”, “Warning”, and “Error”.
display_status (str) – The short localizable label for the status.
message (str) – The detailed status message, including for alerts and error messages.
- Keyword Arguments
code (str) – The status code.
level (str or StatusLevelTypes) – The level code. Known values are: “Info”, “Warning”, and “Error”.
display_status (str) – The short localizable label for the status.
message (str) – The detailed status message, including for alerts and error messages.
time (datetime) – The time of the status.
-
class
azure.mgmt.compute.v2018_10_01.models.
IntervalInMins
(value)[source]¶ -
Interval value in minutes used to create LogAnalytics call rate logs.
-
FIVE_MINS
= 'FiveMins'¶
-
SIXTY_MINS
= 'SixtyMins'¶
-
THIRTY_MINS
= 'ThirtyMins'¶
-
THREE_MINS
= 'ThreeMins'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
KeyVaultKeyReference
(*, key_url: str, source_vault: _models.SubResource, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a reference to Key Vault Key.
All required parameters must be populated in order to send to Azure.
- Variables
key_url (str) – The URL referencing a key encryption key in Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the key. Required.
- Keyword Arguments
key_url (str) – The URL referencing a key encryption key in Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the key. Required.
-
class
azure.mgmt.compute.v2018_10_01.models.
KeyVaultSecretReference
(*, secret_url: str, source_vault: _models.SubResource, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a reference to Key Vault Secret.
All required parameters must be populated in order to send to Azure.
- Variables
secret_url (str) – The URL referencing a secret in a Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the secret. Required.
- Keyword Arguments
secret_url (str) – The URL referencing a secret in a Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the secret. Required.
-
class
azure.mgmt.compute.v2018_10_01.models.
LinuxConfiguration
(*, disable_password_authentication: Optional[bool] = None, ssh: Optional[_models.SshConfiguration] = None, provision_vm_agent: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the Linux operating system settings on the virtual machine.
<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>`_<br>
<br>
For running non-endorsed distributions, see Information for Non-Endorsed Distributions.- Variables
disable_password_authentication (bool) – Specifies whether password authentication should be disabled.
ssh (SshConfiguration) – Specifies the ssh key configuration for a Linux OS.
provision_vm_agent (bool) – Indicates whether virtual machine agent should be provisioned on the virtual machine.
<br>
<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.
- Keyword Arguments
disable_password_authentication (bool) – Specifies whether password authentication should be disabled.
ssh (SshConfiguration) – Specifies the ssh key configuration for a Linux OS.
provision_vm_agent (bool) – Indicates whether virtual machine agent should be provisioned on the virtual machine.
<br>
<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.
-
class
azure.mgmt.compute.v2018_10_01.models.
ListUsagesResult
(*, value: List[_models.Usage], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Usages operation response.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
LogAnalyticsInputBase
(*, blob_container_sas_uri: str, from_time: datetime.datetime, to_time: datetime.datetime, group_by_throttle_policy: Optional[bool] = None, group_by_operation_name: Optional[bool] = None, group_by_resource_name: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Api input base class for LogAnalytics Api.
All required parameters must be populated in order to send to Azure.
- Variables
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
- Keyword Arguments
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
-
class
azure.mgmt.compute.v2018_10_01.models.
LogAnalyticsOperationResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
LogAnalytics operation status response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
properties (LogAnalyticsOutput) – LogAnalyticsOutput.
-
class
azure.mgmt.compute.v2018_10_01.models.
LogAnalyticsOutput
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
LogAnalytics output properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
output (str) – Output file Uri path to blob container.
-
class
azure.mgmt.compute.v2018_10_01.models.
MaintenanceOperationResultCodeTypes
(value)[source]¶ -
The Last Maintenance Operation Result Code.
-
MAINTENANCE_ABORTED
= 'MaintenanceAborted'¶
-
MAINTENANCE_COMPLETED
= 'MaintenanceCompleted'¶
-
NONE
= 'None'¶
-
RETRY_LATER
= 'RetryLater'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
MaintenanceRedeployStatus
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Maintenance Operation Status.
- Variables
is_customer_initiated_maintenance_allowed (bool) – True, if customer is allowed to perform Maintenance.
pre_maintenance_window_start_time (datetime) – Start Time for the Pre Maintenance Window.
pre_maintenance_window_end_time (datetime) – End Time for the Pre Maintenance Window.
maintenance_window_start_time (datetime) – Start Time for the Maintenance Window.
maintenance_window_end_time (datetime) – End Time for the Maintenance Window.
last_operation_result_code (str or MaintenanceOperationResultCodeTypes) – The Last Maintenance Operation Result Code. Known values are: “None”, “RetryLater”, “MaintenanceAborted”, and “MaintenanceCompleted”.
last_operation_message (str) – Message returned for the last Maintenance Operation.
- Keyword Arguments
is_customer_initiated_maintenance_allowed (bool) – True, if customer is allowed to perform Maintenance.
pre_maintenance_window_start_time (datetime) – Start Time for the Pre Maintenance Window.
pre_maintenance_window_end_time (datetime) – End Time for the Pre Maintenance Window.
maintenance_window_start_time (datetime) – Start Time for the Maintenance Window.
maintenance_window_end_time (datetime) – End Time for the Maintenance Window.
last_operation_result_code (str or MaintenanceOperationResultCodeTypes) – The Last Maintenance Operation Result Code. Known values are: “None”, “RetryLater”, “MaintenanceAborted”, and “MaintenanceCompleted”.
last_operation_message (str) – Message returned for the last Maintenance Operation.
-
class
azure.mgmt.compute.v2018_10_01.models.
ManagedDiskParameters
(*, id: Optional[str] = None, storage_account_type: Optional[Union[str, _models.StorageAccountTypes]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
The parameters of a managed disk.
- Variables
storage_account_type (str or StorageAccountTypes) – 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”.
- Keyword Arguments
id (str) – Resource Id.
storage_account_type (str or StorageAccountTypes) – 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”.
-
class
azure.mgmt.compute.v2018_10_01.models.
NetworkInterfaceReference
(*, id: Optional[str] = None, primary: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Describes a network interface reference.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
NetworkProfile
(*, network_interfaces: Optional[List[_models.NetworkInterfaceReference]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the network interfaces of the virtual machine.
- Variables
network_interfaces (list[NetworkInterfaceReference]) – Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
- Keyword Arguments
network_interfaces (list[NetworkInterfaceReference]) – Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
-
class
azure.mgmt.compute.v2018_10_01.models.
OSDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies information about the operating system disk used by the virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.All required parameters must be populated in order to send to Azure.
- Variables
os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Known values are: “Windows” and “Linux”.encryption_settings (DiskEncryptionSettings) – Specifies the encryption settings for the OS Disk.
<br>
<br>
Minimum api-version: 2015-06-15.name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine should be created.:code:<br>
<br>
Possible values are:<br>
<br>
Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br>
FromImage – 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”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (ManagedDiskParameters) – The managed disk parameters.
- Keyword Arguments
os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Known values are: “Windows” and “Linux”.encryption_settings (DiskEncryptionSettings) – Specifies the encryption settings for the OS Disk.
<br>
<br>
Minimum api-version: 2015-06-15.name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine should be created.:code:<br>
<br>
Possible values are:<br>
<br>
Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br>
FromImage – 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”.disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (ManagedDiskParameters) – The managed disk parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
OSDiskImage
(*, operating_system: Union[str, _models.OperatingSystemTypes], **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Contains the os disk image information.
All required parameters must be populated in order to send to Azure.
- Variables
operating_system (str or OperatingSystemTypes) – The operating system of the osDiskImage. Required. Known values are: “Windows” and “Linux”.
- Keyword Arguments
operating_system (str or OperatingSystemTypes) – The operating system of the osDiskImage. Required. Known values are: “Windows” and “Linux”.
-
class
azure.mgmt.compute.v2018_10_01.models.
OSProfile
(*, 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the operating system settings for the virtual machine.
- Variables
computer_name (str) – Specifies the host OS name of the virtual machine.
<br>
<br>
This name cannot be updated after the VM is created.<br>
<br>
Max-length (Windows): 15 characters<br>
<br>
Max-length (Linux): 64 characters.<br>
<br>
For naming conventions and restrictions see Azure infrastructure services implementation guidelines.admin_username (str) – Specifies the name of the administrator account.
<br>
<br>
Windows-only restriction: Cannot end in “.”<br>
<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”.<br>
<br>
Minimum-length (Linux): 1 character<br>
<br>
Max-length (Linux): 64 characters<br>
<br>
Max-length (Windows): 20 characters<br>
<br>
<li>
For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure<br>
<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.admin_password (str) – Specifies the password of the administrator account.
<br>
<br>
Minimum-length (Windows): 8 characters<br>
<br>
Minimum-length (Linux): 6 characters<br>
<br>
Max-length (Windows): 123 characters<br>
<br>
Max-length (Linux): 72 characters<br>
<br>
Complexity requirements: 3 out of 4 conditions below need to be fulfilled<br>
Has lower characters<br>`Has upper characters :code:`<br>
Has a digit<br>
Has a special character (Regex match [W_])<br>
<br>
Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”<br>
<br>
For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM<br>
<br>
For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.custom_data (str) – 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.
<br>
<br>
For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation.windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (LinuxConfiguration) –
Specifies the Linux operating system settings on the virtual machine.
<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>`_<br>
<br>
For running non-endorsed distributions, see Information for Non-Endorsed Distributions.secrets (list[VaultSecretGroup]) – Specifies set of certificates that should be installed onto the virtual machine.
allow_extension_operations (bool) – Specifies whether extension operations should be allowed on the virtual machine.
<br>
:code:`<br>`This may only be set to False when no extensions are present on the virtual machine.
- Keyword Arguments
computer_name (str) –
Specifies the host OS name of the virtual machine.
<br>
<br>
This name cannot be updated after the VM is created.<br>
<br>
Max-length (Windows): 15 characters<br>
<br>
Max-length (Linux): 64 characters.<br>
<br>
For naming conventions and restrictions see Azure infrastructure services implementation guidelines.admin_username (str) –
Specifies the name of the administrator account.
<br>
<br>
Windows-only restriction: Cannot end in “.”<br>
<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”.<br>
<br>
Minimum-length (Linux): 1 character<br>
<br>
Max-length (Linux): 64 characters<br>
<br>
Max-length (Windows): 20 characters<br>
<br>
<li>
For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure<br>
<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.admin_password (str) –
Specifies the password of the administrator account.
<br>
<br>
Minimum-length (Windows): 8 characters<br>
<br>
Minimum-length (Linux): 6 characters<br>
<br>
Max-length (Windows): 123 characters<br>
<br>
Max-length (Linux): 72 characters<br>
<br>
Complexity requirements: 3 out of 4 conditions below need to be fulfilled<br>
Has lower characters<br>`Has upper characters :code:`<br>
Has a digit<br>
Has a special character (Regex match [W_])<br>
<br>
Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”<br>
<br>
For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM<br>
<br>
For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.custom_data (str) –
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.
<br>
<br>
For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation.windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (LinuxConfiguration) –
Specifies the Linux operating system settings on the virtual machine.
<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>`_<br>
<br>
For running non-endorsed distributions, see Information for Non-Endorsed Distributions.secrets (list[VaultSecretGroup]) – Specifies set of certificates that should be installed onto the virtual machine.
allow_extension_operations (bool) – Specifies whether extension operations should be allowed on the virtual machine.
<br>
:code:`<br>`This may only be set to False when no extensions are present on the virtual machine.
-
class
azure.mgmt.compute.v2018_10_01.models.
OperatingSystemStateTypes
(value)[source]¶ -
The OS State.
-
GENERALIZED
= 'Generalized'¶
-
SPECIALIZED
= 'Specialized'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
OperatingSystemTypes
(value)[source]¶ -
The operating system of the osDiskImage.
-
LINUX
= 'Linux'¶
-
WINDOWS
= 'Windows'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
Plan
(*, name: Optional[str] = None, publisher: Optional[str] = None, product: Optional[str] = None, promotion_code: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
ProtocolTypes
(value)[source]¶ -
Specifies the protocol of listener.
<br>
<br>
Possible values are:<br>
http<br>
<br>
https.-
HTTP
= 'Http'¶
-
HTTPS
= 'Https'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
ProximityPlacementGroup
(*, location: str, tags: Optional[Dict[str, str]] = None, proximity_placement_group_type: Optional[Union[str, _models.ProximityPlacementGroupType]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
proximity_placement_group_type (str or ProximityPlacementGroupType) – Specifies the type of the proximity placement group.
<br>
<br>
Possible values are:<br>
<br>
Standard : Co-locate resources within an Azure region or Availability Zone.<br>
<br>
Ultra : For future use. Known values are: “Standard” and “Ultra”.virtual_machines (list[SubResource]) – A list of references to all virtual machines in the proximity placement group.
virtual_machine_scale_sets (list[SubResource]) – A list of references to all virtual machine scale sets in the proximity placement group.
availability_sets (list[SubResource]) – A list of references to all availability sets in the proximity placement group.
- Keyword Arguments
location (str) – Resource location. Required.
proximity_placement_group_type (str or ProximityPlacementGroupType) – Specifies the type of the proximity placement group.
<br>
<br>
Possible values are:<br>
<br>
Standard : Co-locate resources within an Azure region or Availability Zone.<br>
<br>
Ultra : For future use. Known values are: “Standard” and “Ultra”.
-
class
azure.mgmt.compute.v2018_10_01.models.
ProximityPlacementGroupListResult
(*, value: List[_models.ProximityPlacementGroup], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Proximity Placement Group operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[ProximityPlacementGroup]) – The list of proximity placement groups. Required.
next_link (str) – The URI to fetch the next page of proximity placement groups.
- Keyword Arguments
value (list[ProximityPlacementGroup]) – The list of proximity placement groups. Required.
next_link (str) – The URI to fetch the next page of proximity placement groups.
-
class
azure.mgmt.compute.v2018_10_01.models.
ProximityPlacementGroupType
(value)[source]¶ -
Specifies the type of the proximity placement group.
<br>
<br>
Possible values are:<br>
<br>
Standard : Co-locate resources within an Azure region or Availability Zone.<br>
<br>
Ultra : For future use.-
STANDARD
= 'Standard'¶
-
ULTRA
= 'Ultra'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
ProximityPlacementGroupUpdate
(*, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.UpdateResource
Specifies information about the proximity placement group.
-
class
azure.mgmt.compute.v2018_10_01.models.
PurchasePlan
(*, publisher: str, name: str, product: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
RecoveryWalkResponse
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Response after calling a manual recovery walk.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2018_10_01.models.
RequestRateByIntervalInput
(*, blob_container_sas_uri: str, from_time: datetime.datetime, to_time: datetime.datetime, interval_length: Union[str, _models.IntervalInMins], group_by_throttle_policy: Optional[bool] = None, group_by_operation_name: Optional[bool] = None, group_by_resource_name: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.LogAnalyticsInputBase
Api request input for LogAnalytics getRequestRateByInterval Api.
All required parameters must be populated in order to send to Azure.
- Variables
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
interval_length (str or IntervalInMins) – Interval value in minutes used to create LogAnalytics call rate logs. Required. Known values are: “ThreeMins”, “FiveMins”, “ThirtyMins”, and “SixtyMins”.
- Keyword Arguments
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
interval_length (str or IntervalInMins) – Interval value in minutes used to create LogAnalytics call rate logs. Required. Known values are: “ThreeMins”, “FiveMins”, “ThirtyMins”, and “SixtyMins”.
-
class
azure.mgmt.compute.v2018_10_01.models.
Resource
(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
-
class
azure.mgmt.compute.v2018_10_01.models.
ResourceIdentityType
(value)[source]¶ -
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.
-
NONE
= 'None'¶
-
SYSTEM_ASSIGNED
= 'SystemAssigned'¶
-
SYSTEM_ASSIGNED_USER_ASSIGNED
= 'SystemAssigned, UserAssigned'¶
-
USER_ASSIGNED
= 'UserAssigned'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
RollbackStatusInfo
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradeActionType
(value)[source]¶ -
The last action performed on the rolling upgrade.
-
CANCEL
= 'Cancel'¶
-
START
= 'Start'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradePolicy
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The configuration parameters used while performing a rolling upgrade.
- Variables
max_batch_instance_percent (int) – 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%.
max_unhealthy_instance_percent (int) – 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%.
max_unhealthy_upgraded_instance_percent (int) – 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%.
pause_time_between_batches (str) – 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).
- Keyword Arguments
max_batch_instance_percent (int) – 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%.
max_unhealthy_instance_percent (int) – 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%.
max_unhealthy_upgraded_instance_percent (int) – 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%.
pause_time_between_batches (str) – 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).
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradeProgressInfo
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
successful_instance_count (int) – The number of instances that have been successfully upgraded.
failed_instance_count (int) – The number of instances that have failed to be upgraded successfully.
in_progress_instance_count (int) – The number of instances that are currently being upgraded.
pending_instance_count (int) – The number of instances that have not yet begun to be upgraded.
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradeRunningStatus
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
code (str or RollingUpgradeStatusCode) – Code indicating the current status of the upgrade. Known values are: “RollingForward”, “Cancelled”, “Completed”, and “Faulted”.
start_time (datetime) – Start time of the upgrade.
last_action (str or RollingUpgradeActionType) – The last action performed on the rolling upgrade. Known values are: “Start” and “Cancel”.
last_action_time (datetime) – Last action time of the upgrade.
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradeStatusCode
(value)[source]¶ -
Code indicating the current status of the upgrade.
-
CANCELLED
= 'Cancelled'¶
-
COMPLETED
= 'Completed'¶
-
FAULTED
= 'Faulted'¶
-
ROLLING_FORWARD
= 'RollingForward'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
RollingUpgradeStatusInfo
(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
policy (RollingUpgradePolicy) – The rolling upgrade policies applied for this upgrade.
running_status (RollingUpgradeRunningStatus) – Information about the current running state of the overall upgrade.
progress (RollingUpgradeProgressInfo) – Information about the number of virtual machine instances in each upgrade state.
error (ApiError) – Error details for this upgrade, if there are any.
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandDocument
(*, schema: str, id: str, os_type: Union[str, _models.OperatingSystemTypes], label: str, description: str, script: List[str], parameters: Optional[List[_models.RunCommandParameterDefinition]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.RunCommandDocumentBase
Describes the properties of a Run Command.
All required parameters must be populated in order to send to Azure.
- Variables
schema (str) – The VM run command schema. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
parameters (list[RunCommandParameterDefinition]) – The parameters used by the script.
- Keyword Arguments
schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
parameters (list[RunCommandParameterDefinition]) – The parameters used by the script.
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandDocumentBase
(*, schema: str, id: str, os_type: Union[str, _models.OperatingSystemTypes], label: str, description: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the properties of a Run Command metadata.
All required parameters must be populated in order to send to Azure.
- Variables
schema (str) – The VM run command schema. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
- Keyword Arguments
schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandInput
(*, command_id: str, script: Optional[List[str]] = None, parameters: Optional[List[_models.RunCommandInputParameter]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
- Variables
command_id (str) – The run command id. Required.
script (list[str]) – Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
parameters (list[RunCommandInputParameter]) – The run command parameters.
- Keyword Arguments
command_id (str) – The run command id. Required.
script (list[str]) – Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
parameters (list[RunCommandInputParameter]) – The run command parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandInputParameter
(*, name: str, value: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the properties of a run command parameter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandListResult
(*, value: List[_models.RunCommandDocumentBase], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[RunCommandDocumentBase]) – The list of virtual machine run commands. Required.
next_link (str) – The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.
- Keyword Arguments
value (list[RunCommandDocumentBase]) – The list of virtual machine run commands. Required.
next_link (str) – The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandParameterDefinition
(*, name: str, type: str, default_value: Optional[str] = None, required: bool = False, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the properties of a run command parameter.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
RunCommandResult
(*, value: Optional[List[_models.InstanceViewStatus]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
RunCommandResult.
- Variables
value (list[InstanceViewStatus]) – Run command operation response.
- Keyword Arguments
value (list[InstanceViewStatus]) – Run command operation response.
-
class
azure.mgmt.compute.v2018_10_01.models.
SettingNames
(value)[source]¶ -
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
-
AUTO_LOGON
= 'AutoLogon'¶
-
FIRST_LOGON_COMMANDS
= 'FirstLogonCommands'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
Sku
(*, name: Optional[str] = None, tier: Optional[str] = None, capacity: Optional[int] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
SshConfiguration
(*, public_keys: Optional[List[_models.SshPublicKey]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
SSH configuration for Linux based VMs running on Azure.
- Variables
public_keys (list[SshPublicKey]) – The list of SSH public keys used to authenticate with linux based VMs.
- Keyword Arguments
public_keys (list[SshPublicKey]) – The list of SSH public keys used to authenticate with linux based VMs.
-
class
azure.mgmt.compute.v2018_10_01.models.
SshPublicKey
(*, path: Optional[str] = None, key_data: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
- Variables
path (str) – 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.
key_data (str) – 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.
<br>
<br>
For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.
- Keyword Arguments
path (str) – 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.
key_data (str) –
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.
<br>
<br>
For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.
-
class
azure.mgmt.compute.v2018_10_01.models.
StatusLevelTypes
(value)[source]¶ -
The level code.
-
ERROR
= 'Error'¶
-
INFO
= 'Info'¶
-
WARNING
= 'Warning'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
StorageAccountTypes
(value)[source]¶ -
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.
-
PREMIUM_LRS
= 'Premium_LRS'¶
-
STANDARD_LRS
= 'Standard_LRS'¶
-
STANDARD_SSD_LRS
= 'StandardSSD_LRS'¶
-
ULTRA_SSD_LRS
= 'UltraSSD_LRS'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
StorageProfile
(*, image_reference: Optional[_models.ImageReference] = None, os_disk: Optional[_models.OSDisk] = None, data_disks: Optional[List[_models.DataDisk]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies the storage settings for the virtual machine disks.
- Variables
image_reference (ImageReference) – 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.
os_disk (OSDisk) –
Specifies information about the operating system disk used by the virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.Specifies the parameters that are used to add a data disk to a virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.
- Keyword Arguments
image_reference (ImageReference) – 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.
os_disk (OSDisk) –
Specifies information about the operating system disk used by the virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.Specifies the parameters that are used to add a data disk to a virtual machine.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.
-
class
azure.mgmt.compute.v2018_10_01.models.
SubResource
(*, id: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
SubResource.
-
class
azure.mgmt.compute.v2018_10_01.models.
SubResourceReadOnly
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
SubResourceReadOnly.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2018_10_01.models.
ThrottledRequestsInput
(*, blob_container_sas_uri: str, from_time: datetime.datetime, to_time: datetime.datetime, group_by_throttle_policy: Optional[bool] = None, group_by_operation_name: Optional[bool] = None, group_by_resource_name: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.LogAnalyticsInputBase
Api request input for LogAnalytics getThrottledRequests Api.
All required parameters must be populated in order to send to Azure.
- Variables
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
- Keyword Arguments
blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpdateResource
(*, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The Update Resource model definition.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeMode
(value)[source]¶ -
Specifies the mode of an upgrade to virtual machines in the scale set.:code:<br />
<br />
Possible values are:<br />
<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 /><br />
Automatic - All virtual machines in the scale set are automatically updated at the same time.-
AUTOMATIC
= 'Automatic'¶
-
MANUAL
= 'Manual'¶
-
ROLLING
= 'Rolling'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeOperationHistoricalStatusInfo
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
properties (UpgradeOperationHistoricalStatusInfoProperties) – Information about the properties of the upgrade operation.
location (str) – Resource location.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeOperationHistoricalStatusInfoProperties
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
running_status (UpgradeOperationHistoryStatus) – Information about the overall status of the upgrade operation.
progress (RollingUpgradeProgressInfo) – Counts of the VMs in each state.
error (ApiError) – Error Details for this upgrade if there are any.
started_by (str or UpgradeOperationInvoker) – Invoker of the Upgrade Operation. Known values are: “Unknown”, “User”, and “Platform”.
target_image_reference (ImageReference) – Image Reference details.
rollback_info (RollbackStatusInfo) – Information about OS rollback if performed.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeOperationHistoryStatus
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
code (str or UpgradeState) – Code indicating the current status of the upgrade. Known values are: “RollingForward”, “Cancelled”, “Completed”, and “Faulted”.
start_time (datetime) – Start time of the upgrade.
end_time (datetime) – End time of the upgrade.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeOperationInvoker
(value)[source]¶ -
Invoker of the Upgrade Operation.
-
PLATFORM
= 'Platform'¶
-
UNKNOWN
= 'Unknown'¶
-
USER
= 'User'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradePolicy
(*, mode: Optional[Union[str, _models.UpgradeMode]] = None, rolling_upgrade_policy: Optional[_models.RollingUpgradePolicy] = None, automatic_os_upgrade_policy: Optional[_models.AutomaticOSUpgradePolicy] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes an upgrade policy - automatic, manual, or rolling.
- Variables
mode (str or UpgradeMode) – Specifies the mode of an upgrade to virtual machines in the scale set.:code:<br />
<br />
Possible values are:<br />
<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 /><br />
Automatic - All virtual machines in the scale set are automatically updated at the same time. Known values are: “Automatic”, “Manual”, and “Rolling”.rolling_upgrade_policy (RollingUpgradePolicy) – The configuration parameters used while performing a rolling upgrade.
automatic_os_upgrade_policy (AutomaticOSUpgradePolicy) – Configuration parameters used for performing automatic OS Upgrade.
- Keyword Arguments
mode (str or UpgradeMode) – Specifies the mode of an upgrade to virtual machines in the scale set.:code:<br />
<br />
Possible values are:<br />
<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 /><br />
Automatic - All virtual machines in the scale set are automatically updated at the same time. Known values are: “Automatic”, “Manual”, and “Rolling”.rolling_upgrade_policy (RollingUpgradePolicy) – The configuration parameters used while performing a rolling upgrade.
automatic_os_upgrade_policy (AutomaticOSUpgradePolicy) – Configuration parameters used for performing automatic OS Upgrade.
-
class
azure.mgmt.compute.v2018_10_01.models.
UpgradeState
(value)[source]¶ -
Code indicating the current status of the upgrade.
-
CANCELLED
= 'Cancelled'¶
-
COMPLETED
= 'Completed'¶
-
FAULTED
= 'Faulted'¶
-
ROLLING_FORWARD
= 'RollingForward'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
Usage
(*, current_value: int, limit: int, name: _models.UsageName, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
- Keyword Arguments
-
unit
= 'Count'¶
-
class
azure.mgmt.compute.v2018_10_01.models.
UsageName
(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The Usage Names.
-
class
azure.mgmt.compute.v2018_10_01.models.
UserAssignedIdentitiesValue
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
UserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2018_10_01.models.
VaultCertificate
(*, certificate_url: Optional[str] = None, certificate_store: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
- Variables
certificate_url (str) – 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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
<br>
<br>
{<br>
“data”:”<Base64-encoded-certificate>
”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>
”<br>
}.certificate_store (str) – 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.
<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.
- Keyword Arguments
certificate_url (str) –
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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
<br>
<br>
{<br>
“data”:”<Base64-encoded-certificate>
”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>
”<br>
}.certificate_store (str) – 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.
<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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VaultSecretGroup
(*, source_vault: Optional[_models.SubResource] = None, vault_certificates: Optional[List[_models.VaultCertificate]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a set of certificates which are all in the same Key Vault.
- Variables
source_vault (SubResource) – The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates (list[VaultCertificate]) – The list of key vault references in SourceVault which contain certificates.
- Keyword Arguments
source_vault (SubResource) – The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates (list[VaultCertificate]) – The list of key vault references in SourceVault which contain certificates.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualHardDisk
(*, uri: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the uri of a disk.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachine
(*, 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, proximity_placement_group: Optional[_models.SubResource] = None, license_type: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.Resource
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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
plan (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.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
license_type (str) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.vm_id (str) – 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.
- Keyword Arguments
location (str) – Resource location. Required.
plan (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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineAgentInstanceView
(*, vm_agent_version: Optional[str] = None, extension_handlers: Optional[List[_models.VirtualMachineExtensionHandlerInstanceView]] = None, statuses: Optional[List[_models.InstanceViewStatus]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The instance view of the VM Agent running on the virtual machine.
- Variables
vm_agent_version (str) – The VM Agent full version.
extension_handlers (list[VirtualMachineExtensionHandlerInstanceView]) – The virtual machine extension handler instance view.
statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
vm_agent_version (str) – The VM Agent full version.
extension_handlers (list[VirtualMachineExtensionHandlerInstanceView]) – The virtual machine extension handler instance view.
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineCaptureParameters
(*, vhd_prefix: str, destination_container_name: str, overwrite_vhds: bool, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineCaptureResult
(*, id: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Output of virtual machine capture operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Keyword Arguments
id (str) – Resource Id.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineEvictionPolicyTypes
(value)[source]¶ -
Specifies the eviction policy for virtual machines in a low priority scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview.-
DEALLOCATE
= 'Deallocate'¶
-
DELETE
= 'Delete'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtension
(*, 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[collections.abc.MutableMapping[str, Any]] = None, protected_settings: Optional[collections.abc.MutableMapping[str, Any]] = None, instance_view: Optional[_models.VirtualMachineExtensionInstanceView] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.Resource
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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
- Keyword Arguments
location (str) – Resource location. Required.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtensionHandlerInstanceView
(*, type: Optional[str] = None, type_handler_version: Optional[str] = None, status: Optional[_models.InstanceViewStatus] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The instance view of a virtual machine extension handler.
- Variables
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
status (InstanceViewStatus) – The extension handler status.
- Keyword Arguments
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
status (InstanceViewStatus) – The extension handler status.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtensionImage
(*, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
operating_system (str) – The operating system this extension supports.
compute_role (str) – The type of role (IaaS or PaaS) this extension supports.
handler_schema (str) – The schema defined by publisher, where extension consumers should provide settings in a matching schema.
vm_scale_set_enabled (bool) – 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.
supports_multiple_extensions (bool) – Whether the handler can support multiple extensions.
- Keyword Arguments
location (str) – Resource location. Required.
operating_system (str) – The operating system this extension supports.
compute_role (str) – The type of role (IaaS or PaaS) this extension supports.
handler_schema (str) – The schema defined by publisher, where extension consumers should provide settings in a matching schema.
vm_scale_set_enabled (bool) – 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.
supports_multiple_extensions (bool) – Whether the handler can support multiple extensions.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtensionInstanceView
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The instance view of a virtual machine extension.
- Variables
name (str) – The virtual machine extension name.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
substatuses (list[InstanceViewStatus]) – The resource status information.
statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
name (str) – The virtual machine extension name.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
substatuses (list[InstanceViewStatus]) – The resource status information.
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtensionUpdate
(*, 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[collections.abc.MutableMapping[str, Any]] = None, protected_settings: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.UpdateResource
Describes a Virtual Machine Extension.
- Variables
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- Keyword Arguments
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineExtensionsListResult
(*, value: Optional[List[_models.VirtualMachineExtension]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Extension operation response.
- Variables
value (list[VirtualMachineExtension]) – The list of extensions.
- Keyword Arguments
value (list[VirtualMachineExtension]) – The list of extensions.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineHealthStatus
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The health status of the VM.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
status (InstanceViewStatus) – The health status information for the VM.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineIdentity
(*, type: Optional[Union[str, _models.ResourceIdentityType]] = None, user_assigned_identities: Optional[Dict[str, _models.UserAssignedIdentitiesValue]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Identity for the virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
principal_id (str) – The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
type (str or ResourceIdentityType) – 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”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’.
- Keyword Arguments
type (str or ResourceIdentityType) – 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”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineImage
(*, name: str, location: str, id: Optional[str] = None, 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.VirtualMachineImageResource
Describes a Virtual Machine Image.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
tags (dict[str, str]) – Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
plan (PurchasePlan) – Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
os_disk_image (OSDiskImage) – Contains the os disk image information.
data_disk_images (list[DataDiskImage]) –
automatic_os_upgrade_properties (AutomaticOSUpgradeProperties) – Describes automatic OS upgrade properties on the image.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
plan (PurchasePlan) – Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
os_disk_image (OSDiskImage) – Contains the os disk image information.
data_disk_images (list[DataDiskImage]) –
automatic_os_upgrade_properties (AutomaticOSUpgradeProperties) – Describes automatic OS upgrade properties on the image.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineImageResource
(*, name: str, location: str, id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Virtual machine image resource information.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineInstanceView
(*, 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, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The instance view of a virtual machine.
- Variables
platform_update_domain (int) – Specifies the update domain of the virtual machine.
platform_fault_domain (int) – Specifies the fault domain of the virtual machine.
computer_name (str) – The computer name assigned to the virtual machine.
os_name (str) – The Operating System running on the virtual machine.
os_version (str) – The version of Operating System running on the virtual machine.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The virtual machine disk information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
boot_diagnostics (BootDiagnosticsInstanceView) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
platform_update_domain (int) – Specifies the update domain of the virtual machine.
platform_fault_domain (int) – Specifies the fault domain of the virtual machine.
computer_name (str) – The computer name assigned to the virtual machine.
os_name (str) – The Operating System running on the virtual machine.
os_version (str) – The version of Operating System running on the virtual machine.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The virtual machine disk information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
boot_diagnostics (BootDiagnosticsInstanceView) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineListResult
(*, value: List[_models.VirtualMachine], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachine]) – The list of virtual machines. Required.
next_link (str) – The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.
- Keyword Arguments
value (list[VirtualMachine]) – The list of virtual machines. Required.
next_link (str) – The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachinePriorityTypes
(value)[source]¶ -
Specifies the priority for the virtual machines in the scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview.-
LOW
= 'Low'¶
-
REGULAR
= 'Regular'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineReimageParameters
(*, temp_disk: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged.
- Variables
temp_disk (bool) – 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.
- Keyword Arguments
temp_disk (bool) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSet
(*, 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.Resource
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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
sku (Sku) – The virtual machine scale set sku.
plan (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.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.
provisioning_state (str) – The provisioning state, which only appears in the response.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
unique_id (str) – Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
single_placement_group (bool) – When true this limits the scale set to a single placement group, of max size 100 virtual machines.
zone_balance (bool) – Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
platform_fault_domain_count (int) – Fault Domain count for each placement group.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
- Keyword Arguments
location (str) – Resource location. Required.
sku (Sku) – The virtual machine scale set sku.
plan (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.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – When true this limits the scale set to a single placement group, of max size 100 virtual machines.
zone_balance (bool) – Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
platform_fault_domain_count (int) – Fault Domain count for each placement group.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetDataDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set data disk.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The disk name.
lun (int) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – The create option. Required. Known values are: “FromImage”, “Empty”, and “Attach”.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
- Keyword Arguments
name (str) – The disk name.
lun (int) – 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.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – The create option. Required. Known values are: “FromImage”, “Empty”, and “Attach”.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetExtension
(*, 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[collections.abc.MutableMapping[str, Any]] = None, protected_settings: Optional[collections.abc.MutableMapping[str, Any]] = None, provision_after_extensions: Optional[List[str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResourceReadOnly
Describes a Virtual Machine Scale Set Extension.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The name of the extension.
force_update_tag (str) – 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.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
- Keyword Arguments
name (str) – The name of the extension.
force_update_tag (str) – 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.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetExtensionListResult
(*, value: List[_models.VirtualMachineScaleSetExtension], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List VM scale set extension operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachineScaleSetExtension]) – The list of VM scale set extensions. Required.
next_link (str) – 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.
- Keyword Arguments
value (list[VirtualMachineScaleSetExtension]) – The list of VM scale set extensions. Required.
next_link (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetExtensionProfile
(*, extensions: Optional[List[_models.VirtualMachineScaleSetExtension]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set extension profile.
- Variables
extensions (list[VirtualMachineScaleSetExtension]) – The virtual machine scale set child extension resources.
- Keyword Arguments
extensions (list[VirtualMachineScaleSetExtension]) – The virtual machine scale set child extension resources.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetIPConfiguration
(*, name: str, id: Optional[str] = None, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s IP configuration.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The IP configuration name. Required.
subnet (ApiEntityReference) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachineScaleSetPublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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”.
application_gateway_backend_address_pools (list[SubResource]) – 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.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – 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.
load_balancer_inbound_nat_pools (list[SubResource]) – 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.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The IP configuration name. Required.
subnet (ApiEntityReference) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachineScaleSetPublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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”.
application_gateway_backend_address_pools (list[SubResource]) – 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.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – 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.
load_balancer_inbound_nat_pools (list[SubResource]) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetIdentity
(*, type: Optional[Union[str, _models.ResourceIdentityType]] = None, user_assigned_identities: Optional[Dict[str, _models.VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Identity for the virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
principal_id (str) – The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.
type (str or ResourceIdentityType) – 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”.
user_assigned_identities (dict[str, VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue]) – 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}’.
- Keyword Arguments
type (str or ResourceIdentityType) – 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”.
user_assigned_identities (dict[str, VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue]) – 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}’.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetInstanceView
(*, statuses: Optional[List[_models.InstanceViewStatus]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
virtual_machine (VirtualMachineScaleSetInstanceViewStatusesSummary) – The instance view status summary for the virtual machine scale set.
extensions (list[VirtualMachineScaleSetVMExtensionsSummary]) – The extensions information.
statuses (list[InstanceViewStatus]) – The resource status information.
- Keyword Arguments
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetInstanceViewStatusesSummary
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
statuses_summary (list[VirtualMachineStatusCodeCount]) – The extensions information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetIpTag
(*, ip_tag_type: Optional[str] = None, tag: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Contains the IP tag associated with the public IP address.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetListOSUpgradeHistory
(*, value: List[_models.UpgradeOperationHistoricalStatusInfo], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
value (list[UpgradeOperationHistoricalStatusInfo]) – The list of OS upgrades performed on the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.
- Keyword Arguments
value (list[UpgradeOperationHistoricalStatusInfo]) – The list of OS upgrades performed on the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetListResult
(*, value: List[_models.VirtualMachineScaleSet], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.
- Keyword Arguments
value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetListSkusResult
(*, value: List[_models.VirtualMachineScaleSetSku], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The Virtual Machine Scale Set List Skus operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachineScaleSetSku]) – The list of skus available for the virtual machine scale set. Required.
next_link (str) – 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.
- Keyword Arguments
value (list[VirtualMachineScaleSetSku]) – The list of skus available for the virtual machine scale set. Required.
next_link (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetListWithLinkResult
(*, value: List[_models.VirtualMachineScaleSet], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – 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.
- Keyword Arguments
value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetManagedDiskParameters
(*, storage_account_type: Optional[Union[str, _models.StorageAccountTypes]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the parameters of a ScaleSet managed disk.
- Variables
storage_account_type (str or StorageAccountTypes) – 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”.
- Keyword Arguments
storage_account_type (str or StorageAccountTypes) – 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”.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetNetworkConfiguration
(*, name: str, id: 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.VirtualMachineScaleSetIPConfiguration]] = None, enable_ip_forwarding: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s network configurations.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The network configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetIPConfiguration]) – Specifies the IP configurations of the network interface.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The network configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetIPConfiguration]) – Specifies the IP configurations of the network interface.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetNetworkConfigurationDnsSettings
(*, dns_servers: Optional[List[str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machines scale sets network configuration’s DNS settings.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetNetworkProfile
(*, health_probe: Optional[_models.ApiEntityReference] = None, network_interface_configurations: Optional[List[_models.VirtualMachineScaleSetNetworkConfiguration]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set network profile.
- Variables
health_probe (ApiEntityReference) – 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}’.
network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
- Keyword Arguments
health_probe (ApiEntityReference) – 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}’.
network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetOSDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set operating system disk.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The disk name.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machines in the scale set should be created.:code:<br>
<br>
The only allowed value is: FromImage – 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”.diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Known values are: “Windows” and “Linux”.image (VirtualHardDisk) – Specifies information about the unmanaged user image to base the scale set on.
vhd_containers (list[str]) – Specifies the container urls that are used to store operating system disks for the scale set.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
- Keyword Arguments
name (str) – The disk name.
caching (str or CachingTypes) – Specifies the caching requirements.
<br>
<br>
Possible values are:<br>
<br>
None<br>
<br>
ReadOnly<br>
<br>
ReadWrite<br>
<br>
Default: None for Standard storage. ReadOnly for Premium storage. Known values are: “None”, “ReadOnly”, and “ReadWrite”.write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machines in the scale set should be created.:code:<br>
<br>
The only allowed value is: FromImage – 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”.diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.os_type (str or OperatingSystemTypes) – 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.
<br>
<br>
Possible values are:<br>
<br>
Windows<br>
<br>
Linux. Known values are: “Windows” and “Linux”.image (VirtualHardDisk) – Specifies information about the unmanaged user image to base the scale set on.
vhd_containers (list[str]) – Specifies the container urls that are used to store operating system disks for the scale set.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetOSProfile
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set OS profile.
- Variables
computer_name_prefix (str) – 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.
admin_username (str) –
Specifies the name of the administrator account.
<br>
<br>
Windows-only restriction: Cannot end in “.”<br>
<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”.<br>
<br>
Minimum-length (Linux): 1 character<br>
<br>
Max-length (Linux): 64 characters<br>
<br>
Max-length (Windows): 20 characters<br>
<br>
<li>
For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure<br>
<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.admin_password (str) –
Specifies the password of the administrator account.
<br>
<br>
Minimum-length (Windows): 8 characters<br>
<br>
Minimum-length (Linux): 6 characters<br>
<br>
Max-length (Windows): 123 characters<br>
<br>
Max-length (Linux): 72 characters<br>
<br>
Complexity requirements: 3 out of 4 conditions below need to be fulfilled<br>
Has lower characters<br>`Has upper characters :code:`<br>
Has a digit<br>
Has a special character (Regex match [W_])<br>
<br>
Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”<br>
<br>
For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM<br>
<br>
For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.custom_data (str) –
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.
<br>
<br>
For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation.windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (LinuxConfiguration) –
Specifies the Linux operating system settings on the virtual machine.
<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>`_<br>
<br>
For running non-endorsed distributions, see Information for Non-Endorsed Distributions.secrets (list[VaultSecretGroup]) – Specifies set of certificates that should be installed onto the virtual machines in the scale set.
- Keyword Arguments
computer_name_prefix (str) – 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.
admin_username (str) –
Specifies the name of the administrator account.
<br>
<br>
Windows-only restriction: Cannot end in “.”<br>
<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”.<br>
<br>
Minimum-length (Linux): 1 character<br>
<br>
Max-length (Linux): 64 characters<br>
<br>
Max-length (Windows): 20 characters<br>
<br>
<li>
For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure<br>
<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.admin_password (str) –
Specifies the password of the administrator account.
<br>
<br>
Minimum-length (Windows): 8 characters<br>
<br>
Minimum-length (Linux): 6 characters<br>
<br>
Max-length (Windows): 123 characters<br>
<br>
Max-length (Linux): 72 characters<br>
<br>
Complexity requirements: 3 out of 4 conditions below need to be fulfilled<br>
Has lower characters<br>`Has upper characters :code:`<br>
Has a digit<br>
Has a special character (Regex match [W_])<br>
<br>
Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”<br>
<br>
For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM<br>
<br>
For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.custom_data (str) –
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.
<br>
<br>
For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation.windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (LinuxConfiguration) –
Specifies the Linux operating system settings on the virtual machine.
<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>`_<br>
<br>
For running non-endorsed distributions, see Information for Non-Endorsed Distributions.secrets (list[VaultSecretGroup]) – Specifies set of certificates that should be installed onto the virtual machines in the scale set.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetPublicIPAddressConfiguration
(*, 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)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
name (str) – The publicIP address configuration name. Required.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineScaleSetIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
- Keyword Arguments
name (str) – The publicIP address configuration name. Required.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineScaleSetIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
(*, domain_name_label: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
domain_name_label (str) – 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.
- Keyword Arguments
domain_name_label (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetReimageParameters
(*, temp_disk: Optional[bool] = None, instance_ids: Optional[List[str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.VirtualMachineScaleSetVMReimageParameters
Describes a Virtual Machine Scale Set VM Reimage Parameters.
- Variables
temp_disk (bool) – 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.
instance_ids (list[str]) – 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.
- Keyword Arguments
temp_disk (bool) – 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.
instance_ids (list[str]) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetSku
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
resource_type (str) – The type of resource the sku applies to.
sku (Sku) – The Sku.
capacity (VirtualMachineScaleSetSkuCapacity) – Specifies the number of virtual machines in the scale set.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetSkuCapacity
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes scaling information of a sku.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
minimum (int) – The minimum capacity.
maximum (int) – The maximum capacity that can be set.
default_capacity (int) – The default capacity.
scale_type (str or VirtualMachineScaleSetSkuScaleType) – The scale type applicable to the sku. Known values are: “Automatic” and “None”.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetSkuScaleType
(value)[source]¶ -
The scale type applicable to the sku.
-
AUTOMATIC
= 'Automatic'¶
-
NONE
= 'None'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetStorageProfile
(*, image_reference: Optional[_models.ImageReference] = None, os_disk: Optional[_models.VirtualMachineScaleSetOSDisk] = None, data_disks: Optional[List[_models.VirtualMachineScaleSetDataDisk]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set storage profile.
- Variables
image_reference (ImageReference) – 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.
os_disk (VirtualMachineScaleSetOSDisk) –
Specifies information about the operating system disk used by the virtual machines in the scale set.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.data_disks (list[VirtualMachineScaleSetDataDisk]) –
Specifies the parameters that are used to add data disks to the virtual machines in the scale set.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.
- Keyword Arguments
image_reference (ImageReference) – 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.
os_disk (VirtualMachineScaleSetOSDisk) –
Specifies information about the operating system disk used by the virtual machines in the scale set.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.data_disks (list[VirtualMachineScaleSetDataDisk]) –
Specifies the parameters that are used to add data disks to the virtual machines in the scale set.
<br>
<br>
For more information about disks, see About disks and VHDs for Azure virtual machines.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdate
(*, 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, proximity_placement_group: Optional[_models.SubResource] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.UpdateResource
Describes a Virtual Machine Scale Set.
- Variables
sku (Sku) – The virtual machine scale set sku.
plan (Plan) – The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetUpdateVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
- Keyword Arguments
sku (Sku) – The virtual machine scale set sku.
plan (Plan) – The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetUpdateVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateIPConfiguration
(*, id: Optional[str] = None, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s IP configuration.
- Variables
name (str) – The IP configuration name.
subnet (ApiEntityReference) – The subnet.
primary (bool) – Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
public_ip_address_configuration (VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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”.
application_gateway_backend_address_pools (list[SubResource]) – The application gateway backend address pools.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – The load balancer backend address pools.
load_balancer_inbound_nat_pools (list[SubResource]) – The load balancer inbound nat pools.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The IP configuration name.
subnet (ApiEntityReference) – The subnet.
primary (bool) – Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
public_ip_address_configuration (VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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”.
application_gateway_backend_address_pools (list[SubResource]) – The application gateway backend address pools.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – The load balancer backend address pools.
load_balancer_inbound_nat_pools (list[SubResource]) – The load balancer inbound nat pools.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateNetworkConfiguration
(*, id: Optional[str] = None, 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)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s network configurations.
- Variables
name (str) – The network configuration name.
primary (bool) – Whether this is a primary NIC on a virtual machine.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetUpdateIPConfiguration]) – The virtual machine scale set IP Configuration.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
- Keyword Arguments
id (str) – Resource Id.
name (str) – The network configuration name.
primary (bool) – Whether this is a primary NIC on a virtual machine.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetUpdateIPConfiguration]) – The virtual machine scale set IP Configuration.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateNetworkProfile
(*, network_interface_configurations: Optional[List[_models.VirtualMachineScaleSetUpdateNetworkConfiguration]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set network profile.
- Variables
network_interface_configurations (list[VirtualMachineScaleSetUpdateNetworkConfiguration]) – The list of network configurations.
- Keyword Arguments
network_interface_configurations (list[VirtualMachineScaleSetUpdateNetworkConfiguration]) – The list of network configurations.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateOSDisk
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
- Variables
caching (str or CachingTypes) – The caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.image (VirtualHardDisk) – 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.
vhd_containers (list[str]) – The list of virtual hard disk container uris.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
- Keyword Arguments
caching (str or CachingTypes) – The caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
disk_size_gb (int) – 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.
<br>
<br>
This value cannot be larger than 1023 GB.image (VirtualHardDisk) – 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.
vhd_containers (list[str]) – The list of virtual hard disk container uris.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateOSProfile
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set OS profile.
- Variables
custom_data (str) – A base-64 encoded string of custom data.
windows_configuration (WindowsConfiguration) – The Windows Configuration of the OS profile.
linux_configuration (LinuxConfiguration) – The Linux Configuration of the OS profile.
secrets (list[VaultSecretGroup]) – The List of certificates for addition to the VM.
- Keyword Arguments
custom_data (str) – A base-64 encoded string of custom data.
windows_configuration (WindowsConfiguration) – The Windows Configuration of the OS profile.
linux_configuration (LinuxConfiguration) – The Linux Configuration of the OS profile.
secrets (list[VaultSecretGroup]) – The List of certificates for addition to the VM.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
(*, name: Optional[str] = None, idle_timeout_in_minutes: Optional[int] = None, dns_settings: Optional[_models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration.
- Variables
name (str) – The publicIP address configuration name.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
- Keyword Arguments
name (str) – The publicIP address configuration name.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateStorageProfile
(*, image_reference: Optional[_models.ImageReference] = None, os_disk: Optional[_models.VirtualMachineScaleSetUpdateOSDisk] = None, data_disks: Optional[List[_models.VirtualMachineScaleSetDataDisk]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set storage profile.
- Variables
image_reference (ImageReference) – The image reference.
os_disk (VirtualMachineScaleSetUpdateOSDisk) – The OS disk.
data_disks (list[VirtualMachineScaleSetDataDisk]) – The data disks.
- Keyword Arguments
image_reference (ImageReference) – The image reference.
os_disk (VirtualMachineScaleSetUpdateOSDisk) – The OS disk.
data_disks (list[VirtualMachineScaleSetDataDisk]) – The data disks.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetUpdateVMProfile
(*, 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set virtual machine profile.
- Variables
os_profile (VirtualMachineScaleSetUpdateOSProfile) – The virtual machine scale set OS profile.
storage_profile (VirtualMachineScaleSetUpdateStorageProfile) – The virtual machine scale set storage profile.
network_profile (VirtualMachineScaleSetUpdateNetworkProfile) – The virtual machine scale set network profile.
diagnostics_profile (DiagnosticsProfile) – The virtual machine scale set diagnostics profile.
extension_profile (VirtualMachineScaleSetExtensionProfile) – The virtual machine scale set extension profile.
license_type (str) – The license type, which is for bring your own license scenario.
- Keyword Arguments
os_profile (VirtualMachineScaleSetUpdateOSProfile) – The virtual machine scale set OS profile.
storage_profile (VirtualMachineScaleSetUpdateStorageProfile) – The virtual machine scale set storage profile.
network_profile (VirtualMachineScaleSetUpdateNetworkProfile) – The virtual machine scale set network profile.
diagnostics_profile (DiagnosticsProfile) – The virtual machine scale set diagnostics profile.
extension_profile (VirtualMachineScaleSetExtensionProfile) – The virtual machine scale set extension profile.
license_type (str) – The license type, which is for bring your own license scenario.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVM
(*, 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, diagnostics_profile: Optional[_models.DiagnosticsProfile] = None, availability_set: Optional[_models.SubResource] = None, license_type: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.Resource
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.
- Variables
name (str) – Resource name.
location (str) – Resource location. Required.
instance_id (str) – The virtual machine instance ID.
sku (Sku) – The virtual machine SKU.
plan (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.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
latest_model_applied (bool) – Specifies whether the latest model has been applied to the virtual machine.
vm_id (str) – Azure VM unique ID.
instance_view (VirtualMachineScaleSetVMInstanceView) – The virtual machine instance view.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – 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.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.provisioning_state (str) – The provisioning state, which only appears in the response.
license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.
- Keyword Arguments
location (str) – Resource location. Required.
plan (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.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – 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.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMExtensionsSummary
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
- Variables
name (str) – The extension name.
statuses_summary (list[VirtualMachineStatusCodeCount]) – The extensions information.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMInstanceIDs
(*, instance_ids: Optional[List[str]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies a list of virtual machine instance IDs from the VM scale set.
- Variables
instance_ids (list[str]) – 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.
- Keyword Arguments
instance_ids (list[str]) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMInstanceRequiredIDs
(*, instance_ids: List[str], **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMInstanceView
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
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.
- Variables
platform_update_domain (int) – The Update Domain count.
platform_fault_domain (int) – The Fault Domain count.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The disks information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
vm_health (VirtualMachineHealthStatus) – The health status for the VM.
boot_diagnostics (BootDiagnosticsInstanceView) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.statuses (list[InstanceViewStatus]) – The resource status information.
placement_group_id (str) – The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
- Keyword Arguments
platform_update_domain (int) – The Update Domain count.
platform_fault_domain (int) – The Fault Domain count.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The disks information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
boot_diagnostics (BootDiagnosticsInstanceView) – Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
<br>
<br>
You can easily view the output of your console log.<br>
<br>
Azure also enables you to see a screenshot of the VM from the hypervisor.statuses (list[InstanceViewStatus]) – The resource status information.
placement_group_id (str) – The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMListResult
(*, value: List[_models.VirtualMachineScaleSetVM], next_link: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine Scale Set VMs operation response.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[VirtualMachineScaleSetVM]) – The list of virtual machine scale sets VMs. Required.
next_link (str) – 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.
- Keyword Arguments
value (list[VirtualMachineScaleSetVM]) – The list of virtual machine scale sets VMs. Required.
next_link (str) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMProfile
(*, os_profile: Optional[_models.VirtualMachineScaleSetOSProfile] = None, storage_profile: Optional[_models.VirtualMachineScaleSetStorageProfile] = None, additional_capabilities: Optional[_models.AdditionalCapabilities] = 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, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes a virtual machine scale set virtual machine profile.
- Variables
os_profile (VirtualMachineScaleSetOSProfile) – Specifies the operating system settings for the virtual machines in the scale set.
storage_profile (VirtualMachineScaleSetStorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – 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.
network_profile (VirtualMachineScaleSetNetworkProfile) – Specifies properties of the network interfaces of the virtual machines in the scale set.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.extension_profile (VirtualMachineScaleSetExtensionProfile) – Specifies a collection of settings for extensions installed on virtual machines in the scale set.
license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machines in the scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: “Regular” and “Low”.eviction_policy (str or VirtualMachineEvictionPolicyTypes) – Specifies the eviction policy for virtual machines in a low priority scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: “Deallocate” and “Delete”.
- Keyword Arguments
os_profile (VirtualMachineScaleSetOSProfile) – Specifies the operating system settings for the virtual machines in the scale set.
storage_profile (VirtualMachineScaleSetStorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – 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.
network_profile (VirtualMachineScaleSetNetworkProfile) – Specifies properties of the network interfaces of the virtual machines in the scale set.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.extension_profile (VirtualMachineScaleSetExtensionProfile) – Specifies a collection of settings for extensions installed on virtual machines in the scale set.
license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machines in the scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: “Regular” and “Low”.eviction_policy (str or VirtualMachineEvictionPolicyTypes) – Specifies the eviction policy for virtual machines in a low priority scale set.
<br>
:code:`<br>`Minimum api-version: 2017-10-30-preview. Known values are: “Deallocate” and “Delete”.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineScaleSetVMReimageParameters
(*, temp_disk: Optional[bool] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.VirtualMachineReimageParameters
Describes a Virtual Machine Scale Set VM Reimage Parameters.
- Variables
temp_disk (bool) – 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.
- Keyword Arguments
temp_disk (bool) – 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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineSize
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes the properties of a VM size.
- Variables
name (str) – The name of the virtual machine size.
number_of_cores (int) – The number of cores supported by the virtual machine size.
os_disk_size_in_mb (int) – The OS disk size, in MB, allowed by the virtual machine size.
resource_disk_size_in_mb (int) – The resource disk size, in MB, allowed by the virtual machine size.
memory_in_mb (int) – The amount of memory, in MB, supported by the virtual machine size.
max_data_disk_count (int) – The maximum number of data disks that can be attached to the virtual machine size.
- Keyword Arguments
name (str) – The name of the virtual machine size.
number_of_cores (int) – The number of cores supported by the virtual machine size.
os_disk_size_in_mb (int) – The OS disk size, in MB, allowed by the virtual machine size.
resource_disk_size_in_mb (int) – The resource disk size, in MB, allowed by the virtual machine size.
memory_in_mb (int) – The amount of memory, in MB, supported by the virtual machine size.
max_data_disk_count (int) – The maximum number of data disks that can be attached to the virtual machine size.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineSizeListResult
(*, value: Optional[List[_models.VirtualMachineSize]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
The List Virtual Machine operation response.
- Variables
value (list[VirtualMachineSize]) – The list of virtual machine sizes.
- Keyword Arguments
value (list[VirtualMachineSize]) – The list of virtual machine sizes.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineSizeTypes
(value)[source]¶ -
Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.
<br>
<br>
The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:<br>
<br>
List all available virtual machine sizes in an availability set<br>
<br>
List all available virtual machine sizes in a region<br>
<br>
List all available virtual machine sizes for resizing.-
BASIC_A0
= 'Basic_A0'¶
-
BASIC_A1
= 'Basic_A1'¶
-
BASIC_A2
= 'Basic_A2'¶
-
BASIC_A3
= 'Basic_A3'¶
-
BASIC_A4
= 'Basic_A4'¶
-
STANDARD_A0
= 'Standard_A0'¶
-
STANDARD_A1
= 'Standard_A1'¶
-
STANDARD_A10
= 'Standard_A10'¶
-
STANDARD_A11
= 'Standard_A11'¶
-
STANDARD_A1_V2
= 'Standard_A1_v2'¶
-
STANDARD_A2
= 'Standard_A2'¶
-
STANDARD_A2_M_V2
= 'Standard_A2m_v2'¶
-
STANDARD_A2_V2
= 'Standard_A2_v2'¶
-
STANDARD_A3
= 'Standard_A3'¶
-
STANDARD_A4
= 'Standard_A4'¶
-
STANDARD_A4_M_V2
= 'Standard_A4m_v2'¶
-
STANDARD_A4_V2
= 'Standard_A4_v2'¶
-
STANDARD_A5
= 'Standard_A5'¶
-
STANDARD_A6
= 'Standard_A6'¶
-
STANDARD_A7
= 'Standard_A7'¶
-
STANDARD_A8
= 'Standard_A8'¶
-
STANDARD_A8_M_V2
= 'Standard_A8m_v2'¶
-
STANDARD_A8_V2
= 'Standard_A8_v2'¶
-
STANDARD_A9
= 'Standard_A9'¶
-
STANDARD_B1_MS
= 'Standard_B1ms'¶
-
STANDARD_B1_S
= 'Standard_B1s'¶
-
STANDARD_B2_MS
= 'Standard_B2ms'¶
-
STANDARD_B2_S
= 'Standard_B2s'¶
-
STANDARD_B4_MS
= 'Standard_B4ms'¶
-
STANDARD_B8_MS
= 'Standard_B8ms'¶
-
STANDARD_D1
= 'Standard_D1'¶
-
STANDARD_D11
= 'Standard_D11'¶
-
STANDARD_D11_V2
= 'Standard_D11_v2'¶
-
STANDARD_D12
= 'Standard_D12'¶
-
STANDARD_D12_V2
= 'Standard_D12_v2'¶
-
STANDARD_D13
= 'Standard_D13'¶
-
STANDARD_D13_V2
= 'Standard_D13_v2'¶
-
STANDARD_D14
= 'Standard_D14'¶
-
STANDARD_D14_V2
= 'Standard_D14_v2'¶
-
STANDARD_D15_V2
= 'Standard_D15_v2'¶
-
STANDARD_D16_S_V3
= 'Standard_D16s_v3'¶
-
STANDARD_D16_V3
= 'Standard_D16_v3'¶
-
STANDARD_D1_V2
= 'Standard_D1_v2'¶
-
STANDARD_D2
= 'Standard_D2'¶
-
STANDARD_D2_S_V3
= 'Standard_D2s_v3'¶
-
STANDARD_D2_V2
= 'Standard_D2_v2'¶
-
STANDARD_D2_V3
= 'Standard_D2_v3'¶
-
STANDARD_D3
= 'Standard_D3'¶
-
STANDARD_D32_S_V3
= 'Standard_D32s_v3'¶
-
STANDARD_D32_V3
= 'Standard_D32_v3'¶
-
STANDARD_D3_V2
= 'Standard_D3_v2'¶
-
STANDARD_D4
= 'Standard_D4'¶
-
STANDARD_D4_S_V3
= 'Standard_D4s_v3'¶
-
STANDARD_D4_V2
= 'Standard_D4_v2'¶
-
STANDARD_D4_V3
= 'Standard_D4_v3'¶
-
STANDARD_D5_V2
= 'Standard_D5_v2'¶
-
STANDARD_D64_S_V3
= 'Standard_D64s_v3'¶
-
STANDARD_D64_V3
= 'Standard_D64_v3'¶
-
STANDARD_D8_S_V3
= 'Standard_D8s_v3'¶
-
STANDARD_D8_V3
= 'Standard_D8_v3'¶
-
STANDARD_DS1
= 'Standard_DS1'¶
-
STANDARD_DS11
= 'Standard_DS11'¶
-
STANDARD_DS11_V2
= 'Standard_DS11_v2'¶
-
STANDARD_DS12
= 'Standard_DS12'¶
-
STANDARD_DS12_V2
= 'Standard_DS12_v2'¶
-
STANDARD_DS13
= 'Standard_DS13'¶
-
STANDARD_DS13_2_V2
= 'Standard_DS13-2_v2'¶
-
STANDARD_DS13_4_V2
= 'Standard_DS13-4_v2'¶
-
STANDARD_DS13_V2
= 'Standard_DS13_v2'¶
-
STANDARD_DS14
= 'Standard_DS14'¶
-
STANDARD_DS14_4_V2
= 'Standard_DS14-4_v2'¶
-
STANDARD_DS14_8_V2
= 'Standard_DS14-8_v2'¶
-
STANDARD_DS14_V2
= 'Standard_DS14_v2'¶
-
STANDARD_DS15_V2
= 'Standard_DS15_v2'¶
-
STANDARD_DS1_V2
= 'Standard_DS1_v2'¶
-
STANDARD_DS2
= 'Standard_DS2'¶
-
STANDARD_DS2_V2
= 'Standard_DS2_v2'¶
-
STANDARD_DS3
= 'Standard_DS3'¶
-
STANDARD_DS3_V2
= 'Standard_DS3_v2'¶
-
STANDARD_DS4
= 'Standard_DS4'¶
-
STANDARD_DS4_V2
= 'Standard_DS4_v2'¶
-
STANDARD_DS5_V2
= 'Standard_DS5_v2'¶
-
STANDARD_E16_S_V3
= 'Standard_E16s_v3'¶
-
STANDARD_E16_V3
= 'Standard_E16_v3'¶
-
STANDARD_E2_S_V3
= 'Standard_E2s_v3'¶
-
STANDARD_E2_V3
= 'Standard_E2_v3'¶
-
STANDARD_E32_16_V3
= 'Standard_E32-16_v3'¶
-
STANDARD_E32_8_S_V3
= 'Standard_E32-8s_v3'¶
-
STANDARD_E32_S_V3
= 'Standard_E32s_v3'¶
-
STANDARD_E32_V3
= 'Standard_E32_v3'¶
-
STANDARD_E4_S_V3
= 'Standard_E4s_v3'¶
-
STANDARD_E4_V3
= 'Standard_E4_v3'¶
-
STANDARD_E64_16_S_V3
= 'Standard_E64-16s_v3'¶
-
STANDARD_E64_32_S_V3
= 'Standard_E64-32s_v3'¶
-
STANDARD_E64_S_V3
= 'Standard_E64s_v3'¶
-
STANDARD_E64_V3
= 'Standard_E64_v3'¶
-
STANDARD_E8_S_V3
= 'Standard_E8s_v3'¶
-
STANDARD_E8_V3
= 'Standard_E8_v3'¶
-
STANDARD_F1
= 'Standard_F1'¶
-
STANDARD_F16
= 'Standard_F16'¶
-
STANDARD_F16_S
= 'Standard_F16s'¶
-
STANDARD_F16_S_V2
= 'Standard_F16s_v2'¶
-
STANDARD_F1_S
= 'Standard_F1s'¶
-
STANDARD_F2
= 'Standard_F2'¶
-
STANDARD_F2_S
= 'Standard_F2s'¶
-
STANDARD_F2_S_V2
= 'Standard_F2s_v2'¶
-
STANDARD_F32_S_V2
= 'Standard_F32s_v2'¶
-
STANDARD_F4
= 'Standard_F4'¶
-
STANDARD_F4_S
= 'Standard_F4s'¶
-
STANDARD_F4_S_V2
= 'Standard_F4s_v2'¶
-
STANDARD_F64_S_V2
= 'Standard_F64s_v2'¶
-
STANDARD_F72_S_V2
= 'Standard_F72s_v2'¶
-
STANDARD_F8
= 'Standard_F8'¶
-
STANDARD_F8_S
= 'Standard_F8s'¶
-
STANDARD_F8_S_V2
= 'Standard_F8s_v2'¶
-
STANDARD_G1
= 'Standard_G1'¶
-
STANDARD_G2
= 'Standard_G2'¶
-
STANDARD_G3
= 'Standard_G3'¶
-
STANDARD_G4
= 'Standard_G4'¶
-
STANDARD_G5
= 'Standard_G5'¶
-
STANDARD_GS1
= 'Standard_GS1'¶
-
STANDARD_GS2
= 'Standard_GS2'¶
-
STANDARD_GS3
= 'Standard_GS3'¶
-
STANDARD_GS4
= 'Standard_GS4'¶
-
STANDARD_GS4_4
= 'Standard_GS4-4'¶
-
STANDARD_GS4_8
= 'Standard_GS4-8'¶
-
STANDARD_GS5
= 'Standard_GS5'¶
-
STANDARD_GS5_16
= 'Standard_GS5-16'¶
-
STANDARD_GS5_8
= 'Standard_GS5-8'¶
-
STANDARD_H16
= 'Standard_H16'¶
-
STANDARD_H16_M
= 'Standard_H16m'¶
-
STANDARD_H16_MR
= 'Standard_H16mr'¶
-
STANDARD_H16_R
= 'Standard_H16r'¶
-
STANDARD_H8
= 'Standard_H8'¶
-
STANDARD_H8_M
= 'Standard_H8m'¶
-
STANDARD_L16_S
= 'Standard_L16s'¶
-
STANDARD_L32_S
= 'Standard_L32s'¶
-
STANDARD_L4_S
= 'Standard_L4s'¶
-
STANDARD_L8_S
= 'Standard_L8s'¶
-
STANDARD_M128_32_MS
= 'Standard_M128-32ms'¶
-
STANDARD_M128_64_MS
= 'Standard_M128-64ms'¶
-
STANDARD_M128_MS
= 'Standard_M128ms'¶
-
STANDARD_M128_S
= 'Standard_M128s'¶
-
STANDARD_M64_16_MS
= 'Standard_M64-16ms'¶
-
STANDARD_M64_32_MS
= 'Standard_M64-32ms'¶
-
STANDARD_M64_MS
= 'Standard_M64ms'¶
-
STANDARD_M64_S
= 'Standard_M64s'¶
-
STANDARD_NC12
= 'Standard_NC12'¶
-
STANDARD_NC12_S_V2
= 'Standard_NC12s_v2'¶
-
STANDARD_NC12_S_V3
= 'Standard_NC12s_v3'¶
-
STANDARD_NC24
= 'Standard_NC24'¶
-
STANDARD_NC24_R
= 'Standard_NC24r'¶
-
STANDARD_NC24_RS_V2
= 'Standard_NC24rs_v2'¶
-
STANDARD_NC24_RS_V3
= 'Standard_NC24rs_v3'¶
-
STANDARD_NC24_S_V2
= 'Standard_NC24s_v2'¶
-
STANDARD_NC24_S_V3
= 'Standard_NC24s_v3'¶
-
STANDARD_NC6
= 'Standard_NC6'¶
-
STANDARD_NC6_S_V2
= 'Standard_NC6s_v2'¶
-
STANDARD_NC6_S_V3
= 'Standard_NC6s_v3'¶
-
STANDARD_ND12_S
= 'Standard_ND12s'¶
-
STANDARD_ND24_RS
= 'Standard_ND24rs'¶
-
STANDARD_ND24_S
= 'Standard_ND24s'¶
-
STANDARD_ND6_S
= 'Standard_ND6s'¶
-
STANDARD_NV12
= 'Standard_NV12'¶
-
STANDARD_NV24
= 'Standard_NV24'¶
-
STANDARD_NV6
= 'Standard_NV6'¶
-
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineStatusCodeCount
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._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.
-
class
azure.mgmt.compute.v2018_10_01.models.
VirtualMachineUpdate
(*, 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, proximity_placement_group: Optional[_models.SubResource] = None, license_type: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute.v2018_10_01.models._models_py3.UpdateResource
Describes a Virtual Machine Update.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
plan (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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.vm_id (str) – 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.
- Keyword Arguments
plan (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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state.
<br>
:code:`<br>`Minimum api-version: 2015-06-15.availability_set (SubResource) –
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.
<br>
<br>
For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure<br>
<br>
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to.
<br>
:code:`<br>`Minimum api-version: 2018-04-01.license_type (str) –
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.
<br>
<br>
Possible values are:<br>
<br>
Windows_Client<br>
<br>
Windows_Server<br>
<br>
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.<br>
<br>
For more information, see Azure Hybrid Use Benefit for Windows Server<br>
<br>
Minimum api-version: 2015-06-15.
-
class
azure.mgmt.compute.v2018_10_01.models.
WinRMConfiguration
(*, listeners: Optional[List[_models.WinRMListener]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes Windows Remote Management configuration of the VM.
- Variables
listeners (list[WinRMListener]) – The list of Windows Remote Management listeners.
- Keyword Arguments
listeners (list[WinRMListener]) – The list of Windows Remote Management listeners.
-
class
azure.mgmt.compute.v2018_10_01.models.
WinRMListener
(*, protocol: Optional[Union[str, _models.ProtocolTypes]] = None, certificate_url: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Describes Protocol and thumbprint of Windows Remote Management listener.
- Variables
protocol (str or ProtocolTypes) – Specifies the protocol of listener.
<br>
<br>
Possible values are:<br>
http<br>
<br>
https. Known values are: “Http” and “Https”.certificate_url (str) –
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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
<br>
<br>
{<br>
“data”:”<Base64-encoded-certificate>
”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>
”<br>
}.
- Keyword Arguments
protocol (str or ProtocolTypes) – Specifies the protocol of listener.
<br>
<br>
Possible values are:<br>
http<br>
<br>
https. Known values are: “Http” and “Https”.certificate_url (str) –
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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
<br>
<br>
{<br>
“data”:”<Base64-encoded-certificate>
”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>
”<br>
}.
-
class
azure.mgmt.compute.v2018_10_01.models.
WindowsConfiguration
(*, 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)[source]¶ Bases:
azure.mgmt.compute._serialization.Model
Specifies Windows operating system settings on the virtual machine.
- Variables
provision_vm_agent (bool) – Indicates whether virtual machine agent should be provisioned on the virtual machine.
<br>
<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.enable_automatic_updates (bool) – Indicates whether virtual machine is enabled for automatic Windows updates. Default value is true.
<br>
<br>
For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.time_zone (str) – Specifies the time zone of the virtual machine. e.g. “Pacific Standard Time”.
additional_unattend_content (list[AdditionalUnattendContent]) – Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
win_rm (WinRMConfiguration) – Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
- Keyword Arguments
provision_vm_agent (bool) – Indicates whether virtual machine agent should be provisioned on the virtual machine.
<br>
<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.enable_automatic_updates (bool) – Indicates whether virtual machine is enabled for automatic Windows updates. Default value is true.
<br>
<br>
For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.time_zone (str) – Specifies the time zone of the virtual machine. e.g. “Pacific Standard Time”.
additional_unattend_content (list[AdditionalUnattendContent]) – Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
win_rm (WinRMConfiguration) – Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.