azure.mgmt.compute.v2019_03_01.models module¶
-
class
azure.mgmt.compute.v2019_03_01.models.
AccessUri
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
A disk access SAS uri.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
access_sas (str) – A SAS uri for accessing a disk.
-
class
azure.mgmt.compute.v2019_03_01.models.
AdditionalCapabilities
(*, ultra_ssd_enabled: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Enables or disables a capability on the virtual machine or virtual machine scale set.
- Parameters
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.v2019_03_01.models.
AdditionalUnattendContent
(*, pass_name=None, component_name=None, setting_name=None, content: str = None, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
pass_name (str or PassNames) – The pass name. Currently, the only allowable value is OobeSystem. Possible values include: ‘OobeSystem’
component_name (str or ComponentNames) – The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: ‘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. Possible values include: ‘AutoLogon’, ‘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.v2019_03_01.models.
ApiEntityReference
(*, id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The API entity reference.
- Parameters
id (str) – The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…
-
class
azure.mgmt.compute.v2019_03_01.models.
ApiError
(*, details=None, innererror=None, code: str = None, target: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Api error.
- Parameters
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.v2019_03_01.models.
ApiErrorBase
(*, code: str = None, target: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Api error base.
-
class
azure.mgmt.compute.v2019_03_01.models.
AutomaticOSUpgradePolicy
(*, enable_automatic_os_upgrade: bool = None, disable_automatic_rollback: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The configuration parameters used for performing automatic OS upgrade.
- Parameters
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. <br><br> If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true.
disable_automatic_rollback (bool) – Whether OS image rollback feature should be disabled. Default value is false.
-
class
azure.mgmt.compute.v2019_03_01.models.
AutomaticOSUpgradeProperties
(*, automatic_os_upgrade_supported: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes automatic OS upgrade properties on the image.
All required parameters must be populated in order to send to Azure.
- Parameters
automatic_os_upgrade_supported (bool) – Required. Specifies whether automatic OS upgrade is supported on the image.
-
class
azure.mgmt.compute.v2019_03_01.models.
AutomaticRepairsPolicy
(*, enabled: bool = None, grace_period: str = None, max_instance_repairs_percent: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
- Parameters
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 default value is 5 minutes (PT5M).
max_instance_repairs_percent (int) – The percentage (capacity of scaleset) of virtual machines that will be simultaneously repaired. The default value is 20%.
-
class
azure.mgmt.compute.v2019_03_01.models.
AvailabilitySet
(*, location: str, tags=None, platform_update_domain_count: int = None, platform_fault_domain_count: int = None, virtual_machines=None, proximity_placement_group=None, sku=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <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
- Parameters
location (str) – Required. Resource location
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><br>Minimum api-version: 2018-04-01.
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’.
-
class
azure.mgmt.compute.v2019_03_01.models.
AvailabilitySetUpdate
(*, tags=None, platform_update_domain_count: int = None, platform_fault_domain_count: int = None, virtual_machines=None, proximity_placement_group=None, sku=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
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><br>Minimum api-version: 2018-04-01.
sku (Sku) – Sku of the availability set
- Variables
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2019_03_01.models.
BillingProfile
(*, max_price: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the billing related details of a low priority VM or VMSS. <br><br>Minimum api-version: 2019-03-01.
- Parameters
max_price (float) – Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. <br><br> This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. <br><br> The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. <br><br> Possible values are: <br><br> - Any decimal value greater than zero. Example: $0.01538 <br><br> -1 – indicates default price to be up-to on-demand. <br><br> You can set the maxPrice to -1 to indicate that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. <br><br>Minimum api-version: 2019-03-01.
-
class
azure.mgmt.compute.v2019_03_01.models.
BootDiagnostics
(*, enabled: bool = None, storage_uri: str = None, **kwargs)[source]¶ Bases:
msrest.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.
-
class
azure.mgmt.compute.v2019_03_01.models.
BootDiagnosticsInstanceView
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
ComputeOperationValue
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
CreationData
(*, create_option, storage_account_id: str = None, image_reference=None, source_uri: str = None, source_resource_id: str = None, upload_size_bytes: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Data used when creating a disk.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
create_option (str or DiskCreateOption) – Required. This enumerates the possible sources of a disk’s creation. Possible values include: ‘Empty’, ‘Attach’, ‘FromImage’, ‘Import’, ‘Copy’, ‘Restore’, ‘Upload’
storage_account_id (str) – If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription
image_reference (ImageDiskReference) – Disk source information.
source_uri (str) – If createOption is Import, this is the URI of a blob to be imported into a managed disk.
source_resource_id (str) – If createOption is Copy, this is the ARM id of the source snapshot or disk.
upload_size_bytes (long) – If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- Variables
source_unique_id (str) – If this field is set, this is the unique id identifying the source of this resource.
-
class
azure.mgmt.compute.v2019_03_01.models.
DataDisk
(*, lun: int, create_option, name: str = None, vhd=None, image=None, caching=None, write_accelerator_enabled: bool = None, disk_size_gb: int = None, managed_disk=None, to_be_detached: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a data disk.
All required parameters must be populated in order to send to Azure.
- Parameters
lun (int) – Required. 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.
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. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Required. Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> Attach u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> FromImage u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: ‘FromImage’, ‘Empty’, ‘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.
to_be_detached (bool) – Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset
-
class
azure.mgmt.compute.v2019_03_01.models.
DataDiskImage
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
DedicatedHost
(*, location: str, sku, tags=None, platform_fault_domain: int = None, auto_replace_on_failure: bool = None, license_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the Dedicated host.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Resource name
host_id (str) – A unique id generated and assigned to the dedicated host by the platform. <br><br> Does not change throughout the lifetime of the host.
virtual_machines (list[SubResourceReadOnly]) – A list of references to all virtual machines in the Dedicated Host.
provisioning_time (datetime) – The date when the host was first provisioned.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (DedicatedHostInstanceView) – The dedicated host instance view.
- Parameters
location (str) – Required. Resource location
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. <br><br> Possible values are: <br><br> None <br><br> Windows_Server_Hybrid <br><br> Windows_Server_Perpetual <br><br> Default: None. Possible values include: ‘None’, ‘Windows_Server_Hybrid’, ‘Windows_Server_Perpetual’
sku (Sku) – Required. SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostAllocatableVM
(*, vm_size: str = None, count: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents the dedicated host unutilized capacity in terms of a specific VM size.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostAvailableCapacity
(*, allocatable_vms=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Dedicated host unutilized capacity.
- Parameters
allocatable_vms (list[DedicatedHostAllocatableVM]) – The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostGroup
(*, location: str, platform_fault_domain_count: int, tags=None, zones=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the dedicated host group that the dedicated hosts should be assigned to. <br><br> Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Parameters
location (str) – Required. Resource location
platform_fault_domain_count (int) – Required. Number of fault domains that the host group can span.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostGroupUpdate
(*, platform_fault_domain_count: int, tags=None, zones=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.UpdateResource
Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
platform_fault_domain_count (int) – Required. Number of fault domains that the host group can span.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
- Variables
hosts (list[SubResourceReadOnly]) – A list of references to all dedicated hosts in the dedicated host group.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostInstanceView
(*, available_capacity=None, statuses=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of a dedicated host.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
asset_id (str) – Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- Parameters
available_capacity (DedicatedHostAvailableCapacity) – Unutilized capacity of the dedicated host.
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostUpdate
(*, tags=None, platform_fault_domain: int = None, auto_replace_on_failure: bool = None, license_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.UpdateResource
Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. <br><br> Possible values are: <br><br> None <br><br> Windows_Server_Hybrid <br><br> Windows_Server_Perpetual <br><br> Default: None. Possible values include: ‘None’, ‘Windows_Server_Hybrid’, ‘Windows_Server_Perpetual’
- Variables
host_id (str) – A unique id generated and assigned to the dedicated host by the platform. <br><br> Does not change throughout the lifetime of the host.
virtual_machines (list[SubResourceReadOnly]) – A list of references to all virtual machines in the Dedicated Host.
provisioning_time (datetime) – The date when the host was first provisioned.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (DedicatedHostInstanceView) – The dedicated host instance view.
-
class
azure.mgmt.compute.v2019_03_01.models.
DiagnosticsProfile
(*, boot_diagnostics=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
- Parameters
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.v2019_03_01.models.
DiffDiskSettings
(*, option=None, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
option (str or DiffDiskOptions) – Specifies the ephemeral disk settings for operating system disk. Possible values include: ‘Local’
-
class
azure.mgmt.compute.v2019_03_01.models.
Disallowed
(*, disk_types=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the disallowed disk types.
-
class
azure.mgmt.compute.v2019_03_01.models.
Disk
(*, location: str, creation_data, tags=None, sku=None, zones=None, os_type=None, hyper_vgeneration=None, disk_size_gb: int = None, encryption_settings_collection=None, disk_iops_read_write: int = None, disk_mbps_read_write: int = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Disk resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Resource name
managed_by (str) – A relative URI containing the ID of the VM that has the disk attached.
time_created (datetime) – The time when the disk was created.
disk_size_bytes (long) – The size of the disk in bytes. This field is read only.
unique_id (str) – Unique Guid identifying the resource.
provisioning_state (str) – The disk provisioning state.
disk_state (str or DiskState) – The state of the disk. Possible values include: ‘Unattached’, ‘Attached’, ‘Reserved’, ‘ActiveSAS’, ‘ReadyToUpload’, ‘ActiveUpload’
- Parameters
location (str) – Required. Resource location
sku (DiskSku) –
os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
hyper_vgeneration (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: ‘V1’, ‘V2’
creation_data (CreationData) – Required. Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
disk_iops_read_write (long) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_mbps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskEncryptionSettings
(*, disk_encryption_key=None, key_encryption_key=None, enabled: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a Encryption Settings for a Disk.
- Parameters
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.v2019_03_01.models.
DiskInstanceView
(*, name: str = None, encryption_settings=None, statuses=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of the disk.
- Parameters
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.v2019_03_01.models.
DiskSku
(*, name=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
name (str or DiskStorageAccountTypes) – The sku name. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘StandardSSD_LRS’, ‘UltraSSD_LRS’
- Variables
tier (str) – The sku tier.
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskUpdate
(*, os_type=None, disk_size_gb: int = None, encryption_settings_collection=None, disk_iops_read_write: int = None, disk_mbps_read_write: int = None, tags=None, sku=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Disk update resource.
- Parameters
os_type (str or OperatingSystemTypes) – the Operating System type. Possible values include: ‘Windows’, ‘Linux’
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
disk_iops_read_write (long) – The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
disk_mbps_read_write (int) – The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
sku (DiskSku) –
-
class
azure.mgmt.compute.v2019_03_01.models.
EncryptionSettingsCollection
(*, enabled: bool, encryption_settings=None, encryption_settings_version: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Encryption settings for disk or snapshot.
All required parameters must be populated in order to send to Azure.
- Parameters
enabled (bool) – Required. Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
encryption_settings (list[EncryptionSettingsElement]) – A collection of encryption settings, one for each disk volume.
encryption_settings_version (str) – Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. ‘1.0’ corresponds to Azure Disk Encryption with AAD app.’1.1’ corresponds to Azure Disk Encryption.
-
class
azure.mgmt.compute.v2019_03_01.models.
EncryptionSettingsElement
(*, disk_encryption_key=None, key_encryption_key=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Encryption settings for one disk volume.
- Parameters
disk_encryption_key (KeyVaultAndSecretReference) – Key Vault Secret Url and vault id of the disk encryption key
key_encryption_key (KeyVaultAndKeyReference) – Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.
-
class
azure.mgmt.compute.v2019_03_01.models.
Gallery
(*, location: str, tags=None, description: str = None, identifier=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the Shared Image Gallery that you want to create or update.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryApplication
(*, location: str, supported_os_type, tags=None, description: str = None, eula: str = None, privacy_statement_uri: str = None, release_note_uri: str = None, end_of_life_date=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the gallery Application Definition that you want to create or update.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Parameters
location (str) – Required. Resource location
description (str) – The description of this gallery Application Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Application Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
end_of_life_date (datetime) – The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
supported_os_type (str or OperatingSystemTypes) – Required. This property allows you to specify the supported type of the OS that application is built for. <br><br> Possible values are: <br><br> Windows <br><br> Linux. Possible values include: ‘Windows’, ‘Linux’
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryApplicationVersion
(*, location: str, publishing_profile, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the gallery Application Version that you want to create or update.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Parameters
location (str) – Required. Resource location
publishing_profile (GalleryApplicationVersionPublishingProfile) – Required.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryApplicationVersionPublishingProfile
(*, source, target_regions=None, replica_count: int = None, exclude_from_latest: bool = None, end_of_life_date=None, storage_account_type=None, content_type: str = None, enable_health_check: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryArtifactPublishingProfileBase
The publishing profile of a gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Possible values include: ‘Standard_LRS’, ‘Standard_ZRS’
source (UserArtifactSource) – Required.
content_type (str) – Optional. May be used to help process this file. The type of file contained in the source, e.g. zip, json, etc.
enable_health_check (bool) – Optional. Whether or not this application reports health.
- Variables
published_date (datetime) – The timestamp for when the gallery Image Version is published.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryArtifactPublishingProfileBase
(*, target_regions=None, replica_count: int = None, exclude_from_latest: bool = None, end_of_life_date=None, storage_account_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the basic gallery artifact publishing profile.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Possible values include: ‘Standard_LRS’, ‘Standard_ZRS’
- Variables
published_date (datetime) – The timestamp for when the gallery Image Version is published.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryArtifactSource
(*, managed_image, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
- Parameters
managed_image (ManagedArtifact) – Required.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryDataDiskImage
(**kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryDiskImage
This is the data disk image.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
lun (int) – This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryDiskImage
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the disk image base class.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryIdentifier
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the gallery unique name.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
unique_name (str) – The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImage
(*, location: str, os_type, os_state, identifier, tags=None, description: str = None, eula: str = None, privacy_statement_uri: str = None, release_note_uri: str = None, end_of_life_date=None, recommended=None, disallowed=None, purchase_plan=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the gallery Image Definition that you want to create or update.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Parameters
location (str) – Required. Resource location
description (str) – The description of this gallery Image Definition resource. This property is updatable.
eula (str) – The Eula agreement for the gallery Image Definition.
privacy_statement_uri (str) – The privacy statement uri.
release_note_uri (str) – The release note uri.
os_type (str or OperatingSystemTypes) – Required. This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> Windows <br><br> Linux. Possible values include: ‘Windows’, ‘Linux’
os_state (str or OperatingSystemStateTypes) – Required. This property allows the user to specify whether the virtual machines created under this image are ‘Generalized’ or ‘Specialized’. Possible values include: ‘Generalized’, ‘Specialized’
end_of_life_date (datetime) – The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable.
identifier (GalleryImageIdentifier) – Required.
recommended (RecommendedMachineConfiguration) –
disallowed (Disallowed) –
purchase_plan (ImagePurchasePlan) –
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImageIdentifier
(*, publisher: str, offer: str, sku: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the gallery Image Definition identifier.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImageVersion
(*, location: str, publishing_profile, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Specifies information about the gallery Image Version that you want to create or update.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Resource name
provisioning_state (str or enum) – The current state of the gallery Image Version. The provisioning state, which only appears in the response. Possible values include: ‘Creating’, ‘Updating’, ‘Failed’, ‘Succeeded’, ‘Deleting’, ‘Migrating’
storage_profile (GalleryImageVersionStorageProfile) –
- Parameters
location (str) – Required. Resource location
publishing_profile (GalleryImageVersionPublishingProfile) – Required.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImageVersionPublishingProfile
(*, source, target_regions=None, replica_count: int = None, exclude_from_latest: bool = None, end_of_life_date=None, storage_account_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryArtifactPublishingProfileBase
The publishing profile of a gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
target_regions (list[TargetRegion]) – The target regions where the Image Version is going to be replicated to. This property is updatable.
replica_count (int) – The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
exclude_from_latest (bool) – If set to true, Virtual Machines deployed from the latest version of the Image Definition won’t use this Image Version.
end_of_life_date (datetime) – The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Possible values include: ‘Standard_LRS’, ‘Standard_ZRS’
source (GalleryArtifactSource) – Required.
- Variables
published_date (datetime) – The timestamp for when the gallery Image Version is published.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImageVersionStorageProfile
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the storage profile of a Gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
os_disk_image (GalleryOSDiskImage) –
data_disk_images (list[GalleryDataDiskImage]) – A list of data disk images.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryOSDiskImage
(**kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.GalleryDiskImage
This is the OS disk image.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
size_in_gb (int) – This property indicates the size of the VHD to be created.
host_caching (str or HostCaching) – The host caching of the disk. Valid values are ‘None’, ‘ReadOnly’, and ‘ReadWrite’. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
-
class
azure.mgmt.compute.v2019_03_01.models.
GrantAccessData
(*, access, duration_in_seconds: int, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Data used for requesting a SAS.
All required parameters must be populated in order to send to Azure.
- Parameters
access (str or AccessLevel) – Required. Possible values include: ‘None’, ‘Read’, ‘Write’
duration_in_seconds (int) – Required. Time duration in seconds until the SAS access expires.
-
class
azure.mgmt.compute.v2019_03_01.models.
HardwareProfile
(*, vm_size=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the hardware settings for the virtual machine.
- Parameters
vm_size (str or VirtualMachineSizeTypes) – Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). Possible values include: ‘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’, ‘Standard_NV24’
-
class
azure.mgmt.compute.v2019_03_01.models.
Image
(*, location: str, tags=None, source_virtual_machine=None, storage_profile=None, hyper_vgeneration=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
- Parameters
location (str) – Required. Resource location
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.
hyper_vgeneration (str or HyperVGenerationTypes) – Gets the HyperVGenerationType of the VirtualMachine created from the image. Possible values include: ‘V1’, ‘V2’
-
class
azure.mgmt.compute.v2019_03_01.models.
ImageDataDisk
(*, lun: int, snapshot=None, managed_disk=None, blob_uri: str = None, caching=None, disk_size_gb: int = None, storage_account_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a data disk.
All required parameters must be populated in order to send to Azure.
- Parameters
lun (int) – Required. 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.
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. Possible values include: ‘None’, ‘ReadOnly’, ‘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. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘StandardSSD_LRS’, ‘UltraSSD_LRS’
-
class
azure.mgmt.compute.v2019_03_01.models.
ImageDiskReference
(*, id: str, lun: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The source image used for creating the disk.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
ImageOSDisk
(*, os_type, os_state, snapshot=None, managed_disk=None, blob_uri: str = None, caching=None, disk_size_gb: int = None, storage_account_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes an Operating System disk.
All required parameters must be populated in order to send to Azure.
- Parameters
os_type (str or OperatingSystemTypes) – Required. 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. Possible values include: ‘Windows’, ‘Linux’
os_state (str or OperatingSystemStateTypes) – Required. The OS State. Possible values include: ‘Generalized’, ‘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. Possible values include: ‘None’, ‘ReadOnly’, ‘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. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘StandardSSD_LRS’, ‘UltraSSD_LRS’
-
class
azure.mgmt.compute.v2019_03_01.models.
ImagePurchasePlan
(*, name: str = None, publisher: str = None, product: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the gallery Image Definition purchase plan. This is used by marketplace images.
-
class
azure.mgmt.compute.v2019_03_01.models.
ImageReference
(*, id: str = None, publisher: str = None, offer: str = None, sku: str = None, version: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
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.v2019_03_01.models.
ImageStorageProfile
(*, os_disk=None, data_disks=None, zone_resilient: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a storage profile.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
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.v2019_03_01.models.
ImageUpdate
(*, tags=None, source_virtual_machine=None, storage_profile=None, hyper_vgeneration=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
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.
hyper_vgeneration (str or HyperVGenerationTypes) – Gets the HyperVGenerationType of the VirtualMachine created from the image. Possible values include: ‘V1’, ‘V2’
- Variables
provisioning_state (str) – The provisioning state.
-
class
azure.mgmt.compute.v2019_03_01.models.
InnerError
(*, exceptiontype: str = None, errordetail: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Inner error details.
-
class
azure.mgmt.compute.v2019_03_01.models.
InstanceViewStatus
(*, code: str = None, level=None, display_status: str = None, message: str = None, time=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Instance view status.
- Parameters
code (str) – The status code.
level (str or StatusLevelTypes) – The level code. Possible values include: ‘Info’, ‘Warning’, ‘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.v2019_03_01.models.
KeyVaultAndKeyReference
(*, source_vault, key_url: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.
All required parameters must be populated in order to send to Azure.
- Parameters
source_vault (SourceVault) – Required. Resource id of the KeyVault containing the key or secret
key_url (str) – Required. Url pointing to a key or secret in KeyVault
-
class
azure.mgmt.compute.v2019_03_01.models.
KeyVaultAndSecretReference
(*, source_vault, secret_url: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Key Vault Secret Url and vault id of the encryption key .
All required parameters must be populated in order to send to Azure.
- Parameters
source_vault (SourceVault) – Required. Resource id of the KeyVault containing the key or secret
secret_url (str) – Required. Url pointing to a key or secret in KeyVault
-
class
azure.mgmt.compute.v2019_03_01.models.
KeyVaultKeyReference
(*, key_url: str, source_vault, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a reference to Key Vault Key.
All required parameters must be populated in order to send to Azure.
- Parameters
key_url (str) – Required. The URL referencing a key encryption key in Key Vault.
source_vault (SubResource) – Required. The relative URL of the Key Vault containing the key.
-
class
azure.mgmt.compute.v2019_03_01.models.
KeyVaultSecretReference
(*, secret_url: str, source_vault, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a reference to Key Vault Secret.
All required parameters must be populated in order to send to Azure.
- Parameters
secret_url (str) – Required. The URL referencing a secret in a Key Vault.
source_vault (SubResource) – Required. The relative URL of the Key Vault containing the secret.
-
class
azure.mgmt.compute.v2019_03_01.models.
LinuxConfiguration
(*, disable_password_authentication: bool = None, ssh=None, provision_vm_agent: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the Linux operating system settings on the virtual machine. <br><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
- Parameters
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.v2019_03_01.models.
LogAnalyticsInputBase
(*, blob_container_sas_uri: str, from_time, to_time, group_by_throttle_policy: bool = None, group_by_operation_name: bool = None, group_by_resource_name: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Api input base class for LogAnalytics Api.
All required parameters must be populated in order to send to Azure.
- Parameters
blob_container_sas_uri (str) – Required. SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
from_time (datetime) – Required. From time of the query
to_time (datetime) – Required. To time of the query
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.v2019_03_01.models.
LogAnalyticsOperationResult
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
LogAnalyticsOutput
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
MaintenanceRedeployStatus
(*, is_customer_initiated_maintenance_allowed: bool = None, pre_maintenance_window_start_time=None, pre_maintenance_window_end_time=None, maintenance_window_start_time=None, maintenance_window_end_time=None, last_operation_result_code=None, last_operation_message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Maintenance Operation Status.
- Parameters
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. Possible values include: ‘None’, ‘RetryLater’, ‘MaintenanceAborted’, ‘MaintenanceCompleted’
last_operation_message (str) – Message returned for the last Maintenance Operation.
-
class
azure.mgmt.compute.v2019_03_01.models.
ManagedArtifact
(*, id: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The managed artifact.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Required. The managed artifact id.
-
class
azure.mgmt.compute.v2019_03_01.models.
ManagedDiskParameters
(*, id: str = None, storage_account_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.SubResource
The parameters of a managed disk.
- Parameters
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. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘StandardSSD_LRS’, ‘UltraSSD_LRS’
-
class
azure.mgmt.compute.v2019_03_01.models.
NetworkInterfaceReference
(*, id: str = None, primary: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.SubResource
Describes a network interface reference.
-
class
azure.mgmt.compute.v2019_03_01.models.
NetworkProfile
(*, network_interfaces=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the network interfaces of the virtual machine.
- Parameters
network_interfaces (list[NetworkInterfaceReference]) – Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
-
class
azure.mgmt.compute.v2019_03_01.models.
OSDisk
(*, create_option, os_type=None, encryption_settings=None, name: str = None, vhd=None, image=None, caching=None, write_accelerator_enabled: bool = None, diff_disk_settings=None, disk_size_gb: int = None, managed_disk=None, **kwargs)[source]¶ Bases:
msrest.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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
All required parameters must be populated in order to send to Azure.
- Parameters
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. Possible values include: ‘Windows’, ‘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. Possible values include: ‘None’, ‘ReadOnly’, ‘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) – Required. Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> Attach u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> FromImage u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: ‘FromImage’, ‘Empty’, ‘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.v2019_03_01.models.
OSDiskImage
(*, operating_system, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains the os disk image information.
All required parameters must be populated in order to send to Azure.
- Parameters
operating_system (str or OperatingSystemTypes) – Required. The operating system of the osDiskImage. Possible values include: ‘Windows’, ‘Linux’
-
class
azure.mgmt.compute.v2019_03_01.models.
OSProfile
(*, computer_name: str = None, admin_username: str = None, admin_password: str = None, custom_data: str = None, windows_configuration=None, linux_configuration=None, secrets=None, allow_extension_operations: bool = None, require_guest_provision_signal: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the operating system settings for the virtual machine.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
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 <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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
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><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
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><br>This may only be set to False when no extensions are present on the virtual machine.
require_guest_provision_signal (bool) – Specifies whether the guest provision signal is required from the virtual machine.
-
class
azure.mgmt.compute.v2019_03_01.models.
Plan
(*, name: str = None, publisher: str = None, product: str = None, promotion_code: str = None, **kwargs)[source]¶ Bases:
msrest.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.
-
class
azure.mgmt.compute.v2019_03_01.models.
ProximityPlacementGroup
(*, location: str, tags=None, proximity_placement_group_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
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.
- Parameters
location (str) – Required. Resource location
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. Possible values include: ‘Standard’, ‘Ultra’
-
class
azure.mgmt.compute.v2019_03_01.models.
ProximityPlacementGroupUpdate
(*, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.UpdateResource
Specifies information about the proximity placement group.
-
class
azure.mgmt.compute.v2019_03_01.models.
PurchasePlan
(*, publisher: str, name: str, product: str, **kwargs)[source]¶ Bases:
msrest.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.
-
class
azure.mgmt.compute.v2019_03_01.models.
RecommendedMachineConfiguration
(*, v_cp_us=None, memory=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
- Parameters
v_cp_us (ResourceRange) –
memory (ResourceRange) –
-
class
azure.mgmt.compute.v2019_03_01.models.
RecoveryWalkResponse
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
RegionalReplicationStatus
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the regional replication status.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
region (str) – The region to which the gallery Image Version is being replicated to.
state (str or ReplicationState) – This is the regional replication state. Possible values include: ‘Unknown’, ‘Replicating’, ‘Completed’, ‘Failed’
details (str) – The details of the replication status.
progress (int) – It indicates progress of the replication job.
-
class
azure.mgmt.compute.v2019_03_01.models.
ReplicationStatus
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the replication status of the gallery Image Version.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
aggregated_state (str or AggregatedReplicationState) – This is the aggregated replication status based on all the regional replication status flags. Possible values include: ‘Unknown’, ‘InProgress’, ‘Completed’, ‘Failed’
summary (list[RegionalReplicationStatus]) – This is a summary of replication status for each region.
-
class
azure.mgmt.compute.v2019_03_01.models.
RequestRateByIntervalInput
(*, blob_container_sas_uri: str, from_time, to_time, interval_length, group_by_throttle_policy: bool = None, group_by_operation_name: bool = None, group_by_resource_name: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.LogAnalyticsInputBase
Api request input for LogAnalytics getRequestRateByInterval Api.
All required parameters must be populated in order to send to Azure.
- Parameters
blob_container_sas_uri (str) – Required. SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
from_time (datetime) – Required. From time of the query
to_time (datetime) – Required. To time of the query
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) – Required. Interval value in minutes used to create LogAnalytics call rate logs. Possible values include: ‘ThreeMins’, ‘FiveMins’, ‘ThirtyMins’, ‘SixtyMins’
-
class
azure.mgmt.compute.v2019_03_01.models.
Resource
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
ResourceRange
(*, min: int = None, max: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the resource range.
-
class
azure.mgmt.compute.v2019_03_01.models.
RollbackStatusInfo
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
RollingUpgradePolicy
(*, max_batch_instance_percent: int = None, max_unhealthy_instance_percent: int = None, max_unhealthy_upgraded_instance_percent: int = None, pause_time_between_batches: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The configuration parameters used while performing a rolling upgrade.
- Parameters
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.v2019_03_01.models.
RollingUpgradeProgressInfo
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
RollingUpgradeRunningStatus
(**kwargs)[source]¶ Bases:
msrest.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. Possible values include: ‘RollingForward’, ‘Cancelled’, ‘Completed’, ‘Faulted’
start_time (datetime) – Start time of the upgrade.
last_action (str or RollingUpgradeActionType) – The last action performed on the rolling upgrade. Possible values include: ‘Start’, ‘Cancel’
last_action_time (datetime) – Last action time of the upgrade.
-
class
azure.mgmt.compute.v2019_03_01.models.
RollingUpgradeStatusInfo
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
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.
- Parameters
-
class
azure.mgmt.compute.v2019_03_01.models.
RunCommandDocument
(*, schema: str, id: str, os_type, label: str, description: str, script, parameters=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.RunCommandDocumentBase
Describes the properties of a Run Command.
All required parameters must be populated in order to send to Azure.
- Parameters
schema (str) – Required. The VM run command schema.
id (str) – Required. The VM run command id.
os_type (str or OperatingSystemTypes) – Required. The Operating System type. Possible values include: ‘Windows’, ‘Linux’
label (str) – Required. The VM run command label.
description (str) – Required. The VM run command description.
parameters (list[RunCommandParameterDefinition]) – The parameters used by the script.
-
class
azure.mgmt.compute.v2019_03_01.models.
RunCommandDocumentBase
(*, schema: str, id: str, os_type, label: str, description: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the properties of a Run Command metadata.
All required parameters must be populated in order to send to Azure.
- Parameters
schema (str) – Required. The VM run command schema.
id (str) – Required. The VM run command id.
os_type (str or OperatingSystemTypes) – Required. The Operating System type. Possible values include: ‘Windows’, ‘Linux’
label (str) – Required. The VM run command label.
description (str) – Required. The VM run command description.
-
class
azure.mgmt.compute.v2019_03_01.models.
RunCommandInput
(*, command_id: str, script=None, parameters=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
- Parameters
command_id (str) – Required. The run command id.
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.v2019_03_01.models.
RunCommandInputParameter
(*, name: str, value: str, **kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
RunCommandParameterDefinition
(*, name: str, type: str, default_value: str = None, required: bool = False, **kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
RunCommandResult
(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
RunCommandResult.
- Parameters
value (list[InstanceViewStatus]) – Run command operation response.
-
class
azure.mgmt.compute.v2019_03_01.models.
ScaleInPolicy
(*, rules=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a scale-in policy for a virtual machine scale set.
- Parameters
rules (list[str or VirtualMachineScaleSetScaleInRules]) – The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br>
-
class
azure.mgmt.compute.v2019_03_01.models.
ScheduledEventsProfile
(*, terminate_notification_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ScheduledEventsProfile.
- Parameters
terminate_notification_profile (TerminateNotificationProfile) – Specifies Terminate Scheduled Event related configurations.
-
class
azure.mgmt.compute.v2019_03_01.models.
Sku
(*, name: str = None, tier: str = None, capacity: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set sku.
-
class
azure.mgmt.compute.v2019_03_01.models.
Snapshot
(*, location: str, creation_data, tags=None, sku=None, os_type=None, hyper_vgeneration=None, disk_size_gb: int = None, encryption_settings_collection=None, incremental: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
Snapshot resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Resource name
managed_by (str) – Unused. Always Null.
time_created (datetime) – The time when the disk was created.
disk_size_bytes (long) – The size of the disk in bytes. This field is read only.
unique_id (str) – Unique Guid identifying the resource.
provisioning_state (str) – The disk provisioning state.
- Parameters
location (str) – Required. Resource location
sku (SnapshotSku) –
os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
hyper_vgeneration (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: ‘V1’, ‘V2’
creation_data (CreationData) – Required. Disk source information. CreationData information cannot be changed after the disk has been created.
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
incremental (bool) – Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
-
class
azure.mgmt.compute.v2019_03_01.models.
SnapshotSku
(*, name=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
name (str or SnapshotStorageAccountTypes) – The sku name. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘Standard_ZRS’
- Variables
tier (str) – The sku tier.
-
class
azure.mgmt.compute.v2019_03_01.models.
SnapshotUpdate
(*, os_type=None, disk_size_gb: int = None, encryption_settings_collection=None, tags=None, sku=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Snapshot update resource.
- Parameters
os_type (str or OperatingSystemTypes) – the Operating System type. Possible values include: ‘Windows’, ‘Linux’
disk_size_gb (int) – If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.
encryption_settings_collection (EncryptionSettingsCollection) – Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
sku (SnapshotSku) –
-
class
azure.mgmt.compute.v2019_03_01.models.
SourceVault
(*, id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}.
- Parameters
id (str) – Resource Id
-
class
azure.mgmt.compute.v2019_03_01.models.
SshConfiguration
(*, public_keys=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SSH configuration for Linux based VMs running on Azure.
- Parameters
public_keys (list[SshPublicKey]) – The list of SSH public keys used to authenticate with linux based VMs.
-
class
azure.mgmt.compute.v2019_03_01.models.
SshPublicKey
(*, path: str = None, key_data: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
-
class
azure.mgmt.compute.v2019_03_01.models.
StorageProfile
(*, image_reference=None, os_disk=None, data_disks=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the storage settings for the virtual machine disks.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
data_disks (list[DataDisk]) – 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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
-
class
azure.mgmt.compute.v2019_03_01.models.
SubResource
(*, id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SubResource.
- Parameters
id (str) – Resource Id
-
class
azure.mgmt.compute.v2019_03_01.models.
SubResourceReadOnly
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
SubResourceReadOnly.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2019_03_01.models.
TargetRegion
(*, name: str, regional_replica_count: int = None, storage_account_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the target region information.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the region.
regional_replica_count (int) – The number of replicas of the Image Version to be created per region. This property is updatable.
storage_account_type (str or StorageAccountType) – Specifies the storage account type to be used to store the image. This property is not updatable. Possible values include: ‘Standard_LRS’, ‘Standard_ZRS’
-
class
azure.mgmt.compute.v2019_03_01.models.
TerminateNotificationProfile
(*, not_before_timeout: str = None, enable: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
TerminateNotificationProfile.
- Parameters
not_before_timeout (str) – Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)
enable (bool) – Specifies whether the Terminate Scheduled event is enabled or disabled.
-
class
azure.mgmt.compute.v2019_03_01.models.
ThrottledRequestsInput
(*, blob_container_sas_uri: str, from_time, to_time, group_by_throttle_policy: bool = None, group_by_operation_name: bool = None, group_by_resource_name: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.LogAnalyticsInputBase
Api request input for LogAnalytics getThrottledRequests Api.
All required parameters must be populated in order to send to Azure.
- Parameters
blob_container_sas_uri (str) – Required. SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
from_time (datetime) – Required. From time of the query
to_time (datetime) – Required. To time of the query
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.v2019_03_01.models.
UpdateResource
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The Update Resource model definition.
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeOperationHistoricalStatusInfo
(**kwargs)[source]¶ Bases:
msrest.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.
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeOperationHistoricalStatusInfoProperties
(**kwargs)[source]¶ Bases:
msrest.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. Possible values include: ‘Unknown’, ‘User’, ‘Platform’
target_image_reference (ImageReference) – Image Reference details
rollback_info (RollbackStatusInfo) – Information about OS rollback if performed
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeOperationHistoryStatus
(**kwargs)[source]¶ Bases:
msrest.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. Possible values include: ‘RollingForward’, ‘Cancelled’, ‘Completed’, ‘Faulted’
start_time (datetime) – Start time of the upgrade.
end_time (datetime) – End time of the upgrade.
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradePolicy
(*, mode=None, rolling_upgrade_policy=None, automatic_os_upgrade_policy=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes an upgrade policy - automatic, manual, or rolling.
- Parameters
mode (str or UpgradeMode) – Specifies the mode of an upgrade to virtual machines in the scale set.<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.<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time. Possible values include: ‘Automatic’, ‘Manual’, ‘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.v2019_03_01.models.
Usage
(*, current_value: int, limit: int, name, **kwargs)[source]¶ Bases:
msrest.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
unit (str) – Required. An enum describing the unit of usage measurement. Default value: “Count” .
- Parameters
-
unit
= 'Count'¶
-
class
azure.mgmt.compute.v2019_03_01.models.
UsageName
(*, value: str = None, localized_value: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The Usage Names.
-
class
azure.mgmt.compute.v2019_03_01.models.
UserArtifactSource
(*, file_name: str, media_link: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
VaultCertificate
(*, certificate_url: str = None, certificate_store: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
- Parameters
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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,<br> “dataType”:”pfx”,<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><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.v2019_03_01.models.
VaultSecretGroup
(*, source_vault=None, vault_certificates=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a set of certificates which are all in the same Key Vault.
- Parameters
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.v2019_03_01.models.
VirtualHardDisk
(*, uri: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the uri of a disk.
- Parameters
uri (str) – Specifies the virtual hard disk’s uri.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachine
(*, location: str, tags=None, plan=None, hardware_profile=None, storage_profile=None, additional_capabilities=None, os_profile=None, network_profile=None, diagnostics_profile=None, availability_set=None, virtual_machine_scale_set=None, proximity_placement_group=None, priority=None, eviction_policy=None, billing_profile=None, host=None, license_type: str = None, identity=None, zones=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
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.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
- Parameters
location (str) – Required. Resource location
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.
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><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <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. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
virtual_machine_scale_set (SubResource) – Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: ‘Regular’, ‘Low’
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – Specifies the eviction policy for the low priority virtual machine. Only supported value is ‘Deallocate’. <br><br>Minimum api-version: 2019-03-01. Possible values include: ‘Deallocate’, ‘Delete’
billing_profile (BillingProfile) – Specifies the billing related details of a low priority virtual machine. <br><br>Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineAgentInstanceView
(*, vm_agent_version: str = None, extension_handlers=None, statuses=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of the VM Agent running on the virtual machine.
- Parameters
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.v2019_03_01.models.
VirtualMachineCaptureParameters
(*, vhd_prefix: str, destination_container_name: str, overwrite_vhds: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineCaptureResult
(*, id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
id (str) – Resource Id
- Variables
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineExtension
(*, location: str, tags=None, force_update_tag: str = None, publisher: str = None, virtual_machine_extension_type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, instance_view=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
- Parameters
location (str) – Required. Resource location
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.
virtual_machine_extension_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 (object) – Json formatted public settings for the extension.
protected_settings (object) – 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.v2019_03_01.models.
VirtualMachineExtensionHandlerInstanceView
(*, type: str = None, type_handler_version: str = None, status=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of a virtual machine extension handler.
- Parameters
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.v2019_03_01.models.
VirtualMachineExtensionImage
(*, location: str, operating_system: str, compute_role: str, handler_schema: str, tags=None, vm_scale_set_enabled: bool = None, supports_multiple_extensions: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
- Parameters
location (str) – Required. Resource location
operating_system (str) – Required. The operating system this extension supports.
compute_role (str) – Required. The type of role (IaaS or PaaS) this extension supports.
handler_schema (str) – Required. 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.v2019_03_01.models.
VirtualMachineExtensionInstanceView
(*, name: str = None, type: str = None, type_handler_version: str = None, substatuses=None, statuses=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of a virtual machine extension.
- Parameters
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.v2019_03_01.models.
VirtualMachineExtensionsListResult
(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The List Extension operation response.
- Parameters
value (list[VirtualMachineExtension]) – The list of extensions
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineExtensionUpdate
(*, tags=None, force_update_tag: str = None, publisher: str = None, type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.UpdateResource
Describes a Virtual Machine Extension.
- Parameters
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 (object) – Json formatted public settings for the extension.
protected_settings (object) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineHealthStatus
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineIdentity
(*, type=None, user_assigned_identities=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Identity for the virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
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. Possible values include: ‘SystemAssigned’, ‘UserAssigned’, ‘SystemAssigned, UserAssigned’, ‘None’
user_assigned_identities (dict[str, VirtualMachineIdentityUserAssignedIdentitiesValue]) – 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.v2019_03_01.models.
VirtualMachineIdentityUserAssignedIdentitiesValue
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
VirtualMachineIdentityUserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineImage
(*, name: str, location: str, id: str = None, tags=None, plan=None, os_disk_image=None, data_disk_images=None, automatic_os_upgrade_properties=None, hyper_vgeneration=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineImageResource
Describes a Virtual Machine Image.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Resource Id
name (str) – Required. The name of the resource.
location (str) – Required. The supported Azure location of the resource.
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](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
plan (PurchasePlan) –
os_disk_image (OSDiskImage) –
data_disk_images (list[DataDiskImage]) –
automatic_os_upgrade_properties (AutomaticOSUpgradeProperties) –
hyper_vgeneration (str or HyperVGenerationTypes) – Possible values include: ‘V1’, ‘V2’
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineImageResource
(*, name: str, location: str, id: str = None, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.SubResource
Virtual machine image resource information.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – Resource Id
name (str) – Required. The name of the resource.
location (str) – Required. The supported Azure location of the resource.
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](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineInstanceView
(*, platform_update_domain: int = None, platform_fault_domain: int = None, computer_name: str = None, os_name: str = None, os_version: str = None, hyper_vgeneration=None, rdp_thumb_print: str = None, vm_agent=None, maintenance_redeploy_status=None, disks=None, extensions=None, boot_diagnostics=None, statuses=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The instance view of a virtual machine.
- Parameters
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.
hyper_vgeneration (str or HyperVGenerationType) – Specifies the HyperVGeneration Type associated with a resource. Possible values include: ‘V1’, ‘V2’
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.v2019_03_01.models.
VirtualMachineReimageParameters
(*, temp_disk: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSet
(*, location: str, tags=None, sku=None, plan=None, upgrade_policy=None, automatic_repairs_policy=None, virtual_machine_profile=None, overprovision: bool = None, do_not_run_extensions_on_overprovisioned_vms: bool = None, single_placement_group: bool = None, zone_balance: bool = None, platform_fault_domain_count: int = None, proximity_placement_group=None, additional_capabilities=None, scale_in_policy=None, identity=None, zones=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
- Parameters
location (str) – Required. Resource location
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.
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_vms (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><br>Minimum api-version: 2018-04-01.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
scale_in_policy (ScaleInPolicy) – Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetDataDisk
(*, lun: int, create_option, name: str = None, caching=None, write_accelerator_enabled: bool = None, disk_size_gb: int = None, managed_disk=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set data disk.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – The disk name.
lun (int) – Required. 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.
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. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Required. The create option. Possible values include: ‘FromImage’, ‘Empty’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetExtension
(*, name: str = None, force_update_tag: str = None, publisher: str = None, type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, provision_after_extensions=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
- Parameters
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 (object) – Json formatted public settings for the extension.
protected_settings (object) – 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.v2019_03_01.models.
VirtualMachineScaleSetExtensionProfile
(*, extensions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set extension profile.
- Parameters
extensions (list[VirtualMachineScaleSetExtension]) – The virtual machine scale set child extension resources.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetIdentity
(*, type=None, user_assigned_identities=None, **kwargs)[source]¶ Bases:
msrest.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
- Parameters
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. Possible values include: ‘SystemAssigned’, ‘UserAssigned’, ‘SystemAssigned, UserAssigned’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetInstanceView
(*, statuses=None, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
statuses (list[InstanceViewStatus]) – The resource status information.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetInstanceViewStatusesSummary
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineScaleSetIPConfiguration
(*, name: str, id: str = None, subnet=None, primary: bool = None, public_ip_address_configuration=None, private_ip_address_version=None, application_gateway_backend_address_pools=None, application_security_groups=None, load_balancer_backend_address_pools=None, load_balancer_inbound_nat_pools=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
id (str) – Resource Id
name (str) – Required. The IP configuration name.
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’. Possible values include: ‘IPv4’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetIpTag
(*, ip_tag_type: str = None, tag: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains the IP tag associated with the public IP address.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetManagedDiskParameters
(*, storage_account_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the parameters of a ScaleSet managed disk.
- Parameters
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. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’, ‘StandardSSD_LRS’, ‘UltraSSD_LRS’
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetNetworkConfiguration
(*, name: str, ip_configurations, id: str = None, primary: bool = None, enable_accelerated_networking: bool = None, network_security_group=None, dns_settings=None, enable_ip_forwarding: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
id (str) – Resource Id
name (str) – Required. The network configuration name.
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]) – Required. Specifies the IP configurations of the network interface.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetNetworkConfigurationDnsSettings
(*, dns_servers=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machines scale sets network configuration’s DNS settings.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetNetworkProfile
(*, health_probe=None, network_interface_configurations=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set network profile.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSetOSDisk
(*, create_option, name: str = None, caching=None, write_accelerator_enabled: bool = None, diff_disk_settings=None, disk_size_gb: int = None, os_type=None, image=None, vhd_containers=None, managed_disk=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set operating system disk.
All required parameters must be populated in order to send to Azure.
- Parameters
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. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Required. Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: FromImage u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: ‘FromImage’, ‘Empty’, ‘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. Possible values include: ‘Windows’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetOSProfile
(*, computer_name_prefix: str = None, admin_username: str = None, admin_password: str = None, custom_data: str = None, windows_configuration=None, linux_configuration=None, secrets=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set OS profile.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
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 <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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
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><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
secrets (list[VaultSecretGroup]) – Specifies set of certificates that should be installed onto the virtual machines in the scale set.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetPublicIPAddressConfiguration
(*, name: str, idle_timeout_in_minutes: int = None, dns_settings=None, ip_tags=None, public_ip_prefix=None, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
name (str) – Required. 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 .
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.v2019_03_01.models.
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
(*, domain_name_label: str, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
domain_name_label (str) – Required. 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
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetReimageParameters
(*, temp_disk: bool = None, instance_ids=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineScaleSetVMReimageParameters
Describes a Virtual Machine Scale Set VM Reimage Parameters.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSetSku
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineScaleSetSkuCapacity
(**kwargs)[source]¶ Bases:
msrest.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 (long) – The minimum capacity.
maximum (long) – The maximum capacity that can be set.
default_capacity (long) – The default capacity.
scale_type (str or VirtualMachineScaleSetSkuScaleType) – The scale type applicable to the sku. Possible values include: ‘Automatic’, ‘None’
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetStorageProfile
(*, image_reference=None, os_disk=None, data_disks=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set storage profile.
- Parameters
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetUpdate
(*, tags=None, sku=None, plan=None, upgrade_policy=None, automatic_repairs_policy=None, virtual_machine_profile=None, overprovision: bool = None, do_not_run_extensions_on_overprovisioned_vms: bool = None, single_placement_group: bool = None, additional_capabilities=None, scale_in_policy=None, identity=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.UpdateResource
Describes a Virtual Machine Scale Set.
- Parameters
sku (Sku) – The virtual machine scale set sku.
plan (Plan) – The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
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_vms (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.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
scale_in_policy (ScaleInPolicy) – Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetUpdateIPConfiguration
(*, id: str = None, name: str = None, subnet=None, primary: bool = None, public_ip_address_configuration=None, private_ip_address_version=None, application_gateway_backend_address_pools=None, application_security_groups=None, load_balancer_backend_address_pools=None, load_balancer_inbound_nat_pools=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s IP configuration.
- Parameters
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’. Possible values include: ‘IPv4’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetUpdateNetworkConfiguration
(*, id: str = None, name: str = None, primary: bool = None, enable_accelerated_networking: bool = None, network_security_group=None, dns_settings=None, ip_configurations=None, enable_ip_forwarding: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.SubResource
Describes a virtual machine scale set network profile’s network configurations.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSetUpdateNetworkProfile
(*, health_probe=None, network_interface_configurations=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set network profile.
- Parameters
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[VirtualMachineScaleSetUpdateNetworkConfiguration]) – The list of network configurations.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetUpdateOSDisk
(*, caching=None, write_accelerator_enabled: bool = None, disk_size_gb: int = None, image=None, vhd_containers=None, managed_disk=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
- Parameters
caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘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.v2019_03_01.models.
VirtualMachineScaleSetUpdateOSProfile
(*, custom_data: str = None, windows_configuration=None, linux_configuration=None, secrets=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set OS profile.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
(*, name: str = None, idle_timeout_in_minutes: int = None, dns_settings=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration.
- Parameters
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.v2019_03_01.models.
VirtualMachineScaleSetUpdateStorageProfile
(*, image_reference=None, os_disk=None, data_disks=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set storage profile.
- Parameters
image_reference (ImageReference) – The image reference.
os_disk (VirtualMachineScaleSetUpdateOSDisk) – The OS disk.
data_disks (list[VirtualMachineScaleSetDataDisk]) – The data disks.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetUpdateVMProfile
(*, os_profile=None, storage_profile=None, network_profile=None, diagnostics_profile=None, extension_profile=None, license_type: str = None, billing_profile=None, scheduled_events_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set virtual machine profile.
- Parameters
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.
billing_profile (BillingProfile) – Specifies the billing related details of a low priority VMSS. <br><br>Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVM
(*, location: str, tags=None, hardware_profile=None, storage_profile=None, additional_capabilities=None, os_profile=None, network_profile=None, network_profile_configuration=None, diagnostics_profile=None, availability_set=None, license_type: str = None, protection_policy=None, plan=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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
instance_id (str) – The virtual machine instance ID.
sku (Sku) – The virtual machine SKU.
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.
provisioning_state (str) – The provisioning state, which only appears in the response.
model_definition_applied (str) – Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
- Parameters
location (str) – Required. Resource location
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.
network_profile_configuration (VirtualMachineScaleSetVMNetworkProfileConfiguration) – Specifies the network profile configuration of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. <br><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
protection_policy (VirtualMachineScaleSetVMProtectionPolicy) – Specifies the protection policy of the virtual machine.
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.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMExtensionsSummary
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineScaleSetVMInstanceIDs
(*, instance_ids=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies a list of virtual machine instance IDs from the VM scale set.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMInstanceRequiredIDs
(*, instance_ids, **kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineScaleSetVMInstanceView
(*, platform_update_domain: int = None, platform_fault_domain: int = None, rdp_thumb_print: str = None, vm_agent=None, maintenance_redeploy_status=None, disks=None, extensions=None, boot_diagnostics=None, statuses=None, placement_group_id: str = None, **kwargs)[source]¶ Bases:
msrest.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.
- Parameters
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.
- Variables
vm_health (VirtualMachineHealthStatus) – The health status for the VM.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMNetworkProfileConfiguration
(*, network_interface_configurations=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set VM network profile.
- Parameters
network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMProfile
(*, os_profile=None, storage_profile=None, network_profile=None, diagnostics_profile=None, extension_profile=None, license_type: str = None, priority=None, eviction_policy=None, billing_profile=None, scheduled_events_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes a virtual machine scale set virtual machine profile.
- Parameters
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.
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><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machines in the scale set. <br><br>Minimum api-version: 2017-10-30-preview. Possible values include: ‘Regular’, ‘Low’
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – Specifies the eviction policy for virtual machines in a low priority scale set. <br><br>Minimum api-version: 2017-10-30-preview. Possible values include: ‘Deallocate’, ‘Delete’
billing_profile (BillingProfile) – Specifies the billing related details of a low priority VMSS. <br><br>Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMProtectionPolicy
(*, protect_from_scale_in: bool = None, protect_from_scale_set_actions: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The protection policy of a virtual machine scale set VM.
- Parameters
protect_from_scale_in (bool) – Indicates that the virtual machine scale set VM shouldn’t be considered for deletion during a scale-in operation.
protect_from_scale_set_actions (bool) – Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMReimageParameters
(*, temp_disk: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_01.models._models_py3.VirtualMachineReimageParameters
Describes a Virtual Machine Scale Set VM Reimage Parameters.
- Parameters
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.v2019_03_01.models.
VirtualMachineSize
(*, name: str = None, number_of_cores: int = None, os_disk_size_in_mb: int = None, resource_disk_size_in_mb: int = None, memory_in_mb: int = None, max_data_disk_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the properties of a VM size.
- Parameters
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.v2019_03_01.models.
VirtualMachineStatusCodeCount
(**kwargs)[source]¶ Bases:
msrest.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.v2019_03_01.models.
VirtualMachineUpdate
(*, tags=None, plan=None, hardware_profile=None, storage_profile=None, additional_capabilities=None, os_profile=None, network_profile=None, diagnostics_profile=None, availability_set=None, virtual_machine_scale_set=None, proximity_placement_group=None, priority=None, eviction_policy=None, billing_profile=None, host=None, license_type: str = None, identity=None, zones=None, **kwargs)[source]¶ Bases:
azure.mgmt.compute.v2019_03_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.
- Parameters
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.
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><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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <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. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
virtual_machine_scale_set (SubResource) – Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: ‘Regular’, ‘Low’
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – Specifies the eviction policy for the low priority virtual machine. Only supported value is ‘Deallocate’. <br><br>Minimum api-version: 2019-03-01. Possible values include: ‘Deallocate’, ‘Delete’
billing_profile (BillingProfile) – Specifies the billing related details of a low priority virtual machine. <br><br>Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
- Variables
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
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.
-
class
azure.mgmt.compute.v2019_03_01.models.
VMScaleSetConvertToSinglePlacementGroupInput
(*, active_placement_group_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
VMScaleSetConvertToSinglePlacementGroupInput.
- Parameters
active_placement_group_id (str) – Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances.
-
class
azure.mgmt.compute.v2019_03_01.models.
WindowsConfiguration
(*, provision_vm_agent: bool = None, enable_automatic_updates: bool = None, time_zone: str = None, additional_unattend_content=None, win_rm=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies Windows operating system settings on the virtual machine.
- Parameters
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 Automatic Updates is enabled for the Windows virtual machine. 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.
-
class
azure.mgmt.compute.v2019_03_01.models.
WinRMConfiguration
(*, listeners=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes Windows Remote Management configuration of the VM.
- Parameters
listeners (list[WinRMListener]) – The list of Windows Remote Management listeners
-
class
azure.mgmt.compute.v2019_03_01.models.
WinRMListener
(*, protocol=None, certificate_url: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes Protocol and thumbprint of Windows Remote Management listener.
- Parameters
protocol (str or ProtocolTypes) – Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br> https. Possible values include: ‘Http’, ‘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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,<br> “dataType”:”pfx”,<br> “password”:”<pfx-file-password>”<br>}
-
class
azure.mgmt.compute.v2019_03_01.models.
ComputeOperationValuePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ComputeOperationValue
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
AvailabilitySetPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AvailabilitySet
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineSizePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachineSize
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
ProximityPlacementGroupPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ProximityPlacementGroup
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostGroupPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DedicatedHostGroup
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DedicatedHost
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
UsagePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Usage
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachinePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachine
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
ImagePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Image
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachineScaleSet
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetSkuPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachineScaleSetSku
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeOperationHistoricalStatusInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
UpgradeOperationHistoricalStatusInfo
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetExtensionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachineScaleSetExtension
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetVMPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
VirtualMachineScaleSetVM
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
RunCommandDocumentBasePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
RunCommandDocumentBase
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Gallery
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImagePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GalleryImage
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryImageVersionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GalleryImageVersion
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryApplicationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GalleryApplication
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
GalleryApplicationVersionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GalleryApplicationVersion
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Disk
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
SnapshotPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Snapshot
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.compute.v2019_03_01.models.
HyperVGenerationTypes
[source]¶ -
An enumeration.
-
v1
= 'V1'¶
-
v2
= 'V2'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
StatusLevelTypes
[source]¶ -
An enumeration.
-
error
= 'Error'¶
-
info
= 'Info'¶
-
warning
= 'Warning'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
AvailabilitySetSkuTypes
[source]¶ -
An enumeration.
-
aligned
= 'Aligned'¶
-
classic
= 'Classic'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
ProximityPlacementGroupType
[source]¶ -
An enumeration.
-
standard
= 'Standard'¶
-
ultra
= 'Ultra'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DedicatedHostLicenseTypes
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
windows_server_hybrid
= 'Windows_Server_Hybrid'¶
-
windows_server_perpetual
= 'Windows_Server_Perpetual'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
OperatingSystemTypes
[source]¶ -
An enumeration.
-
linux
= 'Linux'¶
-
windows
= 'Windows'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineSizeTypes
[source]¶ -
An enumeration.
-
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_v2
= 'Standard_A2_v2'¶
-
standard_a2m_v2
= 'Standard_A2m_v2'¶
-
standard_a3
= 'Standard_A3'¶
-
standard_a4
= 'Standard_A4'¶
-
standard_a4_v2
= 'Standard_A4_v2'¶
-
standard_a4m_v2
= 'Standard_A4m_v2'¶
-
standard_a5
= 'Standard_A5'¶
-
standard_a6
= 'Standard_A6'¶
-
standard_a7
= 'Standard_A7'¶
-
standard_a8
= 'Standard_A8'¶
-
standard_a8_v2
= 'Standard_A8_v2'¶
-
standard_a8m_v2
= 'Standard_A8m_v2'¶
-
standard_a9
= 'Standard_A9'¶
-
standard_b1ms
= 'Standard_B1ms'¶
-
standard_b1s
= 'Standard_B1s'¶
-
standard_b2ms
= 'Standard_B2ms'¶
-
standard_b2s
= 'Standard_B2s'¶
-
standard_b4ms
= 'Standard_B4ms'¶
-
standard_b8ms
= '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_v3
= 'Standard_D16_v3'¶
-
standard_d16s_v3
= 'Standard_D16s_v3'¶
-
standard_d1_v2
= 'Standard_D1_v2'¶
-
standard_d2
= 'Standard_D2'¶
-
standard_d2_v2
= 'Standard_D2_v2'¶
-
standard_d2_v3
= 'Standard_D2_v3'¶
-
standard_d2s_v3
= 'Standard_D2s_v3'¶
-
standard_d3
= 'Standard_D3'¶
-
standard_d32_v3
= 'Standard_D32_v3'¶
-
standard_d32s_v3
= 'Standard_D32s_v3'¶
-
standard_d3_v2
= 'Standard_D3_v2'¶
-
standard_d4
= 'Standard_D4'¶
-
standard_d4_v2
= 'Standard_D4_v2'¶
-
standard_d4_v3
= 'Standard_D4_v3'¶
-
standard_d4s_v3
= 'Standard_D4s_v3'¶
-
standard_d5_v2
= 'Standard_D5_v2'¶
-
standard_d64_v3
= 'Standard_D64_v3'¶
-
standard_d64s_v3
= 'Standard_D64s_v3'¶
-
standard_d8_v3
= 'Standard_D8_v3'¶
-
standard_d8s_v3
= 'Standard_D8s_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_v3
= 'Standard_E16_v3'¶
-
standard_e16s_v3
= 'Standard_E16s_v3'¶
-
standard_e2_v3
= 'Standard_E2_v3'¶
-
standard_e2s_v3
= 'Standard_E2s_v3'¶
-
standard_e32_16_v3
= 'Standard_E32-16_v3'¶
-
standard_e32_8s_v3
= 'Standard_E32-8s_v3'¶
-
standard_e32_v3
= 'Standard_E32_v3'¶
-
standard_e32s_v3
= 'Standard_E32s_v3'¶
-
standard_e4_v3
= 'Standard_E4_v3'¶
-
standard_e4s_v3
= 'Standard_E4s_v3'¶
-
standard_e64_16s_v3
= 'Standard_E64-16s_v3'¶
-
standard_e64_32s_v3
= 'Standard_E64-32s_v3'¶
-
standard_e64_v3
= 'Standard_E64_v3'¶
-
standard_e64s_v3
= 'Standard_E64s_v3'¶
-
standard_e8_v3
= 'Standard_E8_v3'¶
-
standard_e8s_v3
= 'Standard_E8s_v3'¶
-
standard_f1
= 'Standard_F1'¶
-
standard_f16
= 'Standard_F16'¶
-
standard_f16s
= 'Standard_F16s'¶
-
standard_f16s_v2
= 'Standard_F16s_v2'¶
-
standard_f1s
= 'Standard_F1s'¶
-
standard_f2
= 'Standard_F2'¶
-
standard_f2s
= 'Standard_F2s'¶
-
standard_f2s_v2
= 'Standard_F2s_v2'¶
-
standard_f32s_v2
= 'Standard_F32s_v2'¶
-
standard_f4
= 'Standard_F4'¶
-
standard_f4s
= 'Standard_F4s'¶
-
standard_f4s_v2
= 'Standard_F4s_v2'¶
-
standard_f64s_v2
= 'Standard_F64s_v2'¶
-
standard_f72s_v2
= 'Standard_F72s_v2'¶
-
standard_f8
= 'Standard_F8'¶
-
standard_f8s
= 'Standard_F8s'¶
-
standard_f8s_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_h16m
= 'Standard_H16m'¶
-
standard_h16mr
= 'Standard_H16mr'¶
-
standard_h16r
= 'Standard_H16r'¶
-
standard_h8
= 'Standard_H8'¶
-
standard_h8m
= 'Standard_H8m'¶
-
standard_l16s
= 'Standard_L16s'¶
-
standard_l32s
= 'Standard_L32s'¶
-
standard_l4s
= 'Standard_L4s'¶
-
standard_l8s
= 'Standard_L8s'¶
-
standard_m128_32ms
= 'Standard_M128-32ms'¶
-
standard_m128_64ms
= 'Standard_M128-64ms'¶
-
standard_m128ms
= 'Standard_M128ms'¶
-
standard_m128s
= 'Standard_M128s'¶
-
standard_m64_16ms
= 'Standard_M64-16ms'¶
-
standard_m64_32ms
= 'Standard_M64-32ms'¶
-
standard_m64ms
= 'Standard_M64ms'¶
-
standard_m64s
= 'Standard_M64s'¶
-
standard_nc12
= 'Standard_NC12'¶
-
standard_nc12s_v2
= 'Standard_NC12s_v2'¶
-
standard_nc12s_v3
= 'Standard_NC12s_v3'¶
-
standard_nc24
= 'Standard_NC24'¶
-
standard_nc24r
= 'Standard_NC24r'¶
-
standard_nc24rs_v2
= 'Standard_NC24rs_v2'¶
-
standard_nc24rs_v3
= 'Standard_NC24rs_v3'¶
-
standard_nc24s_v2
= 'Standard_NC24s_v2'¶
-
standard_nc24s_v3
= 'Standard_NC24s_v3'¶
-
standard_nc6
= 'Standard_NC6'¶
-
standard_nc6s_v2
= 'Standard_NC6s_v2'¶
-
standard_nc6s_v3
= 'Standard_NC6s_v3'¶
-
standard_nd12s
= 'Standard_ND12s'¶
-
standard_nd24rs
= 'Standard_ND24rs'¶
-
standard_nd24s
= 'Standard_ND24s'¶
-
standard_nd6s
= 'Standard_ND6s'¶
-
standard_nv12
= 'Standard_NV12'¶
-
standard_nv24
= 'Standard_NV24'¶
-
standard_nv6
= 'Standard_NV6'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
CachingTypes
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
read_only
= 'ReadOnly'¶
-
read_write
= 'ReadWrite'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskCreateOptionTypes
[source]¶ -
An enumeration.
-
attach
= 'Attach'¶
-
empty
= 'Empty'¶
-
from_image
= 'FromImage'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
StorageAccountTypes
[source]¶ -
An enumeration.
-
standard_lrs
= 'Standard_LRS'¶
-
standard_ssd_lrs
= 'StandardSSD_LRS'¶
-
ultra_ssd_lrs
= 'UltraSSD_LRS'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DiffDiskOptions
[source]¶ -
An enumeration.
-
local
= 'Local'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
PassNames
[source]¶ -
An enumeration.
-
oobe_system
= 'OobeSystem'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
ComponentNames
[source]¶ -
An enumeration.
-
microsoft_windows_shell_setup
= 'Microsoft-Windows-Shell-Setup'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
SettingNames
[source]¶ -
An enumeration.
-
auto_logon
= 'AutoLogon'¶
-
first_logon_commands
= 'FirstLogonCommands'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
ProtocolTypes
[source]¶ -
An enumeration.
-
http
= 'Http'¶
-
https
= 'Https'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
ResourceIdentityType
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
system_assigned
= 'SystemAssigned'¶
-
system_assigned_user_assigned
= 'SystemAssigned, UserAssigned'¶
-
user_assigned
= 'UserAssigned'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
MaintenanceOperationResultCodeTypes
[source]¶ -
An enumeration.
-
maintenance_aborted
= 'MaintenanceAborted'¶
-
maintenance_completed
= 'MaintenanceCompleted'¶
-
none
= 'None'¶
-
retry_later
= 'RetryLater'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
HyperVGenerationType
[source]¶ -
An enumeration.
-
v1
= 'V1'¶
-
v2
= 'V2'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachinePriorityTypes
[source]¶ -
An enumeration.
-
low
= 'Low'¶
-
regular
= 'Regular'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineEvictionPolicyTypes
[source]¶ -
An enumeration.
-
deallocate
= 'Deallocate'¶
-
delete
= 'Delete'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeMode
[source]¶ -
An enumeration.
-
automatic
= 'Automatic'¶
-
manual
= 'Manual'¶
-
rolling
= 'Rolling'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetScaleInRules
[source]¶ -
An enumeration.
-
default
= 'Default'¶
-
newest_vm
= 'NewestVM'¶
-
oldest_vm
= 'OldestVM'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
OperatingSystemStateTypes
[source]¶ -
An enumeration.
-
generalized
= 'Generalized'¶
-
specialized
= 'Specialized'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
IPVersion
[source]¶ -
An enumeration.
-
ipv4
= 'IPv4'¶
-
ipv6
= 'IPv6'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
VirtualMachineScaleSetSkuScaleType
[source]¶ -
An enumeration.
-
automatic
= 'Automatic'¶
-
none
= 'None'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeState
[source]¶ -
An enumeration.
-
cancelled
= 'Cancelled'¶
-
completed
= 'Completed'¶
-
faulted
= 'Faulted'¶
-
rolling_forward
= 'RollingForward'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
UpgradeOperationInvoker
[source]¶ -
An enumeration.
-
platform
= 'Platform'¶
-
unknown
= 'Unknown'¶
-
user
= 'User'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
RollingUpgradeStatusCode
[source]¶ -
An enumeration.
-
cancelled
= 'Cancelled'¶
-
completed
= 'Completed'¶
-
faulted
= 'Faulted'¶
-
rolling_forward
= 'RollingForward'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
RollingUpgradeActionType
[source]¶ -
An enumeration.
-
cancel
= 'Cancel'¶
-
start
= 'Start'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
IntervalInMins
[source]¶ -
An enumeration.
-
five_mins
= 'FiveMins'¶
-
sixty_mins
= 'SixtyMins'¶
-
thirty_mins
= 'ThirtyMins'¶
-
three_mins
= 'ThreeMins'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
AggregatedReplicationState
[source]¶ -
An enumeration.
-
completed
= 'Completed'¶
-
failed
= 'Failed'¶
-
in_progress
= 'InProgress'¶
-
unknown
= 'Unknown'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
ReplicationState
[source]¶ -
An enumeration.
-
completed
= 'Completed'¶
-
failed
= 'Failed'¶
-
replicating
= 'Replicating'¶
-
unknown
= 'Unknown'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
StorageAccountType
[source]¶ -
An enumeration.
-
standard_lrs
= 'Standard_LRS'¶
-
standard_zrs
= 'Standard_ZRS'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
HostCaching
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
read_only
= 'ReadOnly'¶
-
read_write
= 'ReadWrite'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskStorageAccountTypes
[source]¶ -
An enumeration.
Premium SSD locally redundant storage. Best for production and performance sensitive workloads.
-
standard_lrs
= 'Standard_LRS'¶ Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access.
-
standard_ssd_lrs
= 'StandardSSD_LRS'¶ Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test.
-
ultra_ssd_lrs
= 'UltraSSD_LRS'¶ Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads.
-
class
azure.mgmt.compute.v2019_03_01.models.
HyperVGeneration
[source]¶ -
An enumeration.
-
v1
= 'V1'¶
-
v2
= 'V2'¶
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskCreateOption
[source]¶ -
An enumeration.
-
attach
= 'Attach'¶ Disk will be attached to a VM.
-
copy
= 'Copy'¶ Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId.
-
empty
= 'Empty'¶ Create an empty data disk of a size given by diskSizeGB.
-
from_image
= 'FromImage'¶ Create a new disk from a platform image specified by the given imageReference.
-
import_enum
= 'Import'¶ Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId.
-
restore
= 'Restore'¶ Create a new disk by copying from a backup recovery point.
-
upload
= 'Upload'¶ Create a new disk by obtaining a write token and using it to directly upload the contents of the disk.
-
-
class
azure.mgmt.compute.v2019_03_01.models.
DiskState
[source]¶ -
An enumeration.
-
active_sas
= 'ActiveSAS'¶ The disk currently has an Active SAS Uri associated with it.
-
active_upload
= 'ActiveUpload'¶ A disk is created for upload and a write token has been issued for uploading to it.
-
attached
= 'Attached'¶ The disk is currently mounted to a running VM.
-
ready_to_upload
= 'ReadyToUpload'¶ A disk is ready to be created by upload by requesting a write token.
-
reserved
= 'Reserved'¶ The disk is mounted to a stopped-deallocated VM
-
unattached
= 'Unattached'¶ The disk is not being used and can be attached to a VM.
-
-
class
azure.mgmt.compute.v2019_03_01.models.
SnapshotStorageAccountTypes
[source]¶ -
An enumeration.
Premium SSD locally redundant storage
-
standard_lrs
= 'Standard_LRS'¶ Standard HDD locally redundant storage
-
standard_zrs
= 'Standard_ZRS'¶ Standard zone redundant storage
-
class
azure.mgmt.compute.v2019_03_01.models.
AccessLevel
[source]¶ -
An enumeration.
-
none
= 'None'¶
-
read
= 'Read'¶
-
write
= 'Write'¶
-