azure.mgmt.compute.models module

class azure.mgmt.compute.models.InstanceViewStatus(code=None, level=None, display_status=None, message=None, time=None)[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.models.SubResource(id=None)[source]

Bases: msrest.serialization.Model

SubResource.

Parameters:id (str) – Resource Id
class azure.mgmt.compute.models.Sku(name=None, tier=None, capacity=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set sku.

Parameters:
  • name (str) – The sku name.
  • tier (str) – The sku tier.
  • capacity (long) – The sku capacity.
class azure.mgmt.compute.models.AvailabilitySet(location, tags=None, platform_update_domain_count=None, platform_fault_domain_count=None, virtual_machines=None, managed=None, sku=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Create or update availability set parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • platform_update_domain_count (int) – Update Domain count.
  • platform_fault_domain_count (int) – Fault Domain count.
  • virtual_machines (list of SubResource) – A list of references to all virtual machines in the availability set.
  • managed (bool) – If the availability set supports managed disks.
  • sku (Sku) – Sku of the availability set
class azure.mgmt.compute.models.VirtualMachineSize(name=None, number_of_cores=None, os_disk_size_in_mb=None, resource_disk_size_in_mb=None, memory_in_mb=None, max_data_disk_count=None)[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.models.VirtualMachineExtensionImage(location, operating_system, compute_role, handler_schema, tags=None, vm_scale_set_enabled=None, supports_multiple_extensions=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes a Virtual Machine Extension Image.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • operating_system (str) – The operating system this extension supports.
  • compute_role (str) – The type of role (IaaS or PaaS) this extension supports.
  • handler_schema (str) – The schema defined by publisher, where extension consumers should provide settings in a matching schema.
  • vm_scale_set_enabled (bool) – Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
  • supports_multiple_extensions (bool) – Whether the handler can support multiple extensions.
class azure.mgmt.compute.models.VirtualMachineImageResource(name, location, id=None, tags=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.SubResource

Virtual machine image resource information.

Parameters:
  • id (str) – Resource Id
  • name (str) – The name of the resource.
  • location (str) – The supported Azure location of the resource.
  • tags (dict) – The tags attached to the resource.
class azure.mgmt.compute.models.VirtualMachineExtensionInstanceView(name=None, type=None, type_handler_version=None, substatuses=None, statuses=None)[source]

Bases: msrest.serialization.Model

The instance view of a virtual machine extension.

Parameters:
  • name (str) – The virtual machine extension name.
  • type (str) – The full type of the extension handler which includes both publisher and type.
  • type_handler_version (str) – The type version of the extension handler.
  • substatuses (list of InstanceViewStatus) – The resource status information.
  • statuses (list of InstanceViewStatus) – The resource status information.
class azure.mgmt.compute.models.VirtualMachineExtension(location, tags=None, force_update_tag=None, publisher=None, virtual_machine_extension_type=None, type_handler_version=None, auto_upgrade_minor_version=None, settings=None, protected_settings=None, instance_view=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes a Virtual Machine Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – The provisioning state, which only appears in the response.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • 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) – The type of the extension handler.
  • type_handler_version (str) – The type version of the extension handler.
  • auto_upgrade_minor_version (bool) – Whether the extension handler should be automatically upgraded across minor versions.
  • settings (object) – Json formatted public settings for the extension.
  • protected_settings (object) – Json formatted protected settings for the extension.
  • instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
class azure.mgmt.compute.models.PurchasePlan(publisher, name, product)[source]

Bases: msrest.serialization.Model

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Parameters:
  • publisher (str) – The publisher ID.
  • name (str) – The plan ID.
  • product (str) – The product ID.
class azure.mgmt.compute.models.OSDiskImage(operating_system)[source]

Bases: msrest.serialization.Model

Contains the os disk image information.

Parameters:operating_system (str or OperatingSystemTypes) – The operating system of the osDiskImage. Possible values include: ‘Windows’, ‘Linux’
class azure.mgmt.compute.models.DataDiskImage[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) – The LUN number for a data disk. This value is used to identify data disk image inside the VMImage and therefore it must be unique for each data disk.
class azure.mgmt.compute.models.VirtualMachineImage(name, location, id=None, tags=None, plan=None, os_disk_image=None, data_disk_images=None)[source]

Bases: azure.mgmt.compute.models.virtual_machine_image_resource.VirtualMachineImageResource

Describes a Virtual Machine Image.

Parameters:
  • id (str) – Resource Id
  • name (str) – The name of the resource.
  • location (str) – The supported Azure location of the resource.
  • tags (dict) – The tags attached to the resource.
  • plan (PurchasePlan) –
  • os_disk_image (OSDiskImage) –
  • data_disk_images (list of DataDiskImage) –
class azure.mgmt.compute.models.UsageName(value=None, localized_value=None)[source]

Bases: msrest.serialization.Model

The Usage Names.

Parameters:
  • value (str) – The name of the resource.
  • localized_value (str) – The localized name of the resource.
class azure.mgmt.compute.models.Usage(current_value, limit, name)[source]

Bases: msrest.serialization.Model

Describes Compute Resource Usage.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

unit (str) – An enum describing the unit of usage measurement. Default value: “Count” .

Parameters:
  • current_value (int) – The current usage of the resource.
  • limit (long) – The maximum permitted usage of the resource.
  • name (UsageName) – The name of the type of usage.
unit = 'Count'
class azure.mgmt.compute.models.VirtualMachineCaptureParameters(vhd_prefix, destination_container_name, overwrite_vhds)[source]

Bases: msrest.serialization.Model

Capture Virtual Machine parameters.

Parameters:
  • vhd_prefix (str) – The captured virtual hard disk’s name prefix.
  • destination_container_name (str) – The destination container name.
  • overwrite_vhds (bool) – Specifies whether to overwrite the destination virtual hard disk, in case of conflict.
class azure.mgmt.compute.models.VirtualMachineCaptureResult(id=None, output=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.SubResource

Resource Id.

Parameters:
  • id (str) – Resource Id
  • output (object) – Operation output data (raw JSON)
class azure.mgmt.compute.models.Plan(name=None, publisher=None, product=None, promotion_code=None)[source]

Bases: msrest.serialization.Model

Plan for the resource.

Parameters:
  • name (str) – The plan ID.
  • publisher (str) – The publisher ID.
  • product (str) – The offer ID.
  • promotion_code (str) – The promotion code.
class azure.mgmt.compute.models.HardwareProfile(vm_size=None)[source]

Bases: msrest.serialization.Model

Describes a hardware profile.

Parameters:vm_size (str or VirtualMachineSizeTypes) – The virtual machine size name. 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_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_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_G1’, ‘Standard_G2’, ‘Standard_G3’, ‘Standard_G4’, ‘Standard_G5’, ‘Standard_GS1’, ‘Standard_GS2’, ‘Standard_GS3’, ‘Standard_GS4’, ‘Standard_GS5’
class azure.mgmt.compute.models.ImageReference(id=None, publisher=None, offer=None, sku=None, version=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.SubResource

The image reference.

Parameters:
  • id (str) – Resource Id
  • publisher (str) – The image publisher.
  • offer (str) – The image offer.
  • sku (str) – The image SKU.
  • version (str) – The image version. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor and Build are decimal numbers. Specify ‘latest’ to use the latest version of the image.
class azure.mgmt.compute.models.KeyVaultSecretReference(secret_url, source_vault)[source]

Bases: msrest.serialization.Model

Describes a reference to Key Vault Secret.

Parameters:
  • secret_url (str) – The URL referencing a secret in a Key Vault.
  • source_vault (SubResource) – The relative URL of the Key Vault containing the secret.
class azure.mgmt.compute.models.KeyVaultKeyReference(key_url, source_vault)[source]

Bases: msrest.serialization.Model

Describes a reference to Key Vault Key.

Parameters:
  • key_url (str) – The URL referencing a key in a Key Vault.
  • source_vault (SubResource) – The relative URL of the Key Vault containing the key.
class azure.mgmt.compute.models.DiskEncryptionSettings(disk_encryption_key=None, key_encryption_key=None, enabled=None)[source]

Bases: msrest.serialization.Model

Describes a Encryption Settings for a Disk.

Parameters:
  • disk_encryption_key (KeyVaultSecretReference) – The disk encryption key which is a Key Vault Secret.
  • key_encryption_key (KeyVaultKeyReference) – The key encryption key which is Key Vault Key.
  • enabled (bool) – Specifies whether disk encryption should be enabled on the virtual machine.
class azure.mgmt.compute.models.VirtualHardDisk(uri=None)[source]

Bases: msrest.serialization.Model

Describes the uri of a disk.

Parameters:uri (str) – The virtual hard disk’s URI. Must be a valid URI to a virtual hard disk.
class azure.mgmt.compute.models.ManagedDiskParameters(id=None, storage_account_type=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.SubResource

The parameters of a managed disk.

Parameters:
  • id (str) – Resource Id
  • storage_account_type (str or StorageAccountTypes) – The Storage Account type. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
class azure.mgmt.compute.models.OSDisk(create_option, os_type=None, encryption_settings=None, name=None, vhd=None, image=None, caching=None, disk_size_gb=None, managed_disk=None)[source]

Bases: msrest.serialization.Model

Describes an Operating System disk.

Parameters:
  • os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • encryption_settings (DiskEncryptionSettings) – The disk encryption settings.
  • 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 using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist.
  • caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • create_option (str or DiskCreateOptionTypes) – The create option. Possible values include: ‘fromImage’, ‘empty’, ‘attach’
  • disk_size_gb (int) – The initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks.
  • managed_disk (ManagedDiskParameters) – The managed disk parameters.
class azure.mgmt.compute.models.DataDisk(lun, create_option, name=None, vhd=None, image=None, caching=None, disk_size_gb=None, managed_disk=None)[source]

Bases: msrest.serialization.Model

Describes a data disk.

Parameters:
  • lun (int) – The logical unit number.
  • name (str) – The disk name.
  • vhd (VirtualHardDisk) – The virtual hard disk.
  • image (VirtualHardDisk) – The source user image virtual hard disk. This virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist.
  • caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • create_option (str or DiskCreateOptionTypes) – The create option. Possible values include: ‘fromImage’, ‘empty’, ‘attach’
  • disk_size_gb (int) – The initial disk size in GB for blank data disks, and the new desired size for resizing existing OS and data disks.
  • managed_disk (ManagedDiskParameters) – The managed disk parameters.
class azure.mgmt.compute.models.StorageProfile(image_reference=None, os_disk=None, data_disks=None)[source]

Bases: msrest.serialization.Model

Describes a storage profile.

Parameters:
  • image_reference (ImageReference) – The image reference.
  • os_disk (OSDisk) – The OS disk.
  • data_disks (list of DataDisk) – The data disks.
class azure.mgmt.compute.models.AdditionalUnattendContent(pass_name=None, component_name=None, setting_name=None, content=None)[source]

Bases: msrest.serialization.Model

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 a 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) – Setting name (e.g. FirstLogonCommands, AutoLogon ). Possible values include: ‘AutoLogon’, ‘FirstLogonCommands’
  • content (str) – XML formatted content that is added to the unattend.xml file in the specified pass and component. The XML must be less than 4 KB and must include the root element for the setting or feature that is being inserted.
class azure.mgmt.compute.models.WinRMListener(protocol=None, certificate_url=None)[source]

Bases: msrest.serialization.Model

Describes Protocol and thumbprint of Windows Remote Management listener.

Parameters:
  • protocol (str or ProtocolTypes) – The Protocol used by the WinRM listener. Http and Https are supported. Possible values include: ‘Http’, ‘Https’
  • certificate_url (str) – The Certificate URL in KMS for Https listeners. Should be null for Http listeners.
class azure.mgmt.compute.models.WinRMConfiguration(listeners=None)[source]

Bases: msrest.serialization.Model

Describes Windows Remote Management configuration of the VM.

Parameters:listeners (list of WinRMListener) – The list of Windows Remote Management listeners
class azure.mgmt.compute.models.WindowsConfiguration(provision_vm_agent=None, enable_automatic_updates=None, time_zone=None, additional_unattend_content=None, win_rm=None)[source]

Bases: msrest.serialization.Model

Describes Windows Configuration of the OS Profile.

Parameters:
  • provision_vm_agent (bool) – Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true.
  • enable_automatic_updates (bool) – Indicates whether Windows updates are automatically installed on the VM.
  • time_zone (str) – The time zone of the VM
  • additional_unattend_content (list of AdditionalUnattendContent) – Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file.
  • win_rm (WinRMConfiguration) – The Windows Remote Management configuration of the VM
class azure.mgmt.compute.models.SshPublicKey(path=None, key_data=None)[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.
  • key_data (str) – Certificate public key used to authenticate to the VM through SSH. The certificate must be in Pem format with or without headers.
class azure.mgmt.compute.models.SshConfiguration(public_keys=None)[source]

Bases: msrest.serialization.Model

SSH configuration for Linux based VMs running on Azure.

Parameters:public_keys (list of SshPublicKey) – The list of SSH public keys used to authenticate with linux based VMs.
class azure.mgmt.compute.models.LinuxConfiguration(disable_password_authentication=None, ssh=None)[source]

Bases: msrest.serialization.Model

Describes Windows configuration of the OS Profile.

Parameters:
  • disable_password_authentication (bool) – Specifies whether password authentication should be disabled.
  • ssh (SshConfiguration) – The SSH configuration for linux VMs.
class azure.mgmt.compute.models.VaultCertificate(certificate_url=None, certificate_store=None)[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) – The URL referencing a secret in a Key Vault which contains a properly formatted certificate.
  • certificate_store (str) – The Certificate store in LocalMachine to add the certificate to on Windows, leave empty on Linux.
class azure.mgmt.compute.models.VaultSecretGroup(source_vault=None, vault_certificates=None)[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 of VaultCertificate) – The list of key vault references in SourceVault which contain certificates.
class azure.mgmt.compute.models.OSProfile(computer_name=None, admin_username=None, admin_password=None, custom_data=None, windows_configuration=None, linux_configuration=None, secrets=None)[source]

Bases: msrest.serialization.Model

Describes an OS profile.

Parameters:
  • computer_name (str) – Specifies the host OS name of the virtual machine.
  • admin_username (str) – Specifies the name of the administrator account.
  • admin_password (str) – Specifies the password of the administrator account.
  • 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
  • windows_configuration (WindowsConfiguration) – The Windows configuration of the OS profile.
  • linux_configuration (LinuxConfiguration) – The Linux configuration of the OS profile.
  • secrets (list of VaultSecretGroup) – The list of certificates for addition to the VM.
class azure.mgmt.compute.models.NetworkInterfaceReference(id=None, primary=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.SubResource

Describes a network interface reference.

Parameters:
  • id (str) – Resource Id
  • primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
class azure.mgmt.compute.models.NetworkProfile(network_interfaces=None)[source]

Bases: msrest.serialization.Model

Describes a network profile.

Parameters:network_interfaces (list of NetworkInterfaceReference) – Specifies the list of resource IDs for the network interfaces associated with the virtual machine.
class azure.mgmt.compute.models.BootDiagnostics(enabled=None, storage_uri=None)[source]

Bases: msrest.serialization.Model

Describes Boot Diagnostics.

Parameters:
  • enabled (bool) – Whether boot diagnostics should be enabled on the Virtual Machine.
  • storage_uri (str) – URI of the storage account to use for placing the console output and screenshot.
class azure.mgmt.compute.models.DiagnosticsProfile(boot_diagnostics=None)[source]

Bases: msrest.serialization.Model

Describes a diagnostics profile.

Parameters:boot_diagnostics (BootDiagnostics) – Boot Diagnostics is a debugging feature which allows the user to view console output and/or a screenshot of the virtual machine from the hypervisor.
class azure.mgmt.compute.models.VirtualMachineExtensionHandlerInstanceView(type=None, type_handler_version=None, status=None)[source]

Bases: msrest.serialization.Model

The instance view of a virtual machine extension handler.

Parameters:
  • type (str) – Full type of the extension handler which includes both publisher and type.
  • type_handler_version (str) – The type version of the extension handler.
  • status (InstanceViewStatus) – The extension handler status.
class azure.mgmt.compute.models.VirtualMachineAgentInstanceView(vm_agent_version=None, extension_handlers=None, statuses=None)[source]

Bases: msrest.serialization.Model

The instance view of the VM Agent running on the virtual machine.

Parameters:
class azure.mgmt.compute.models.DiskInstanceView(name=None, statuses=None)[source]

Bases: msrest.serialization.Model

The instance view of the disk.

Parameters:
  • name (str) – The disk name.
  • statuses (list of InstanceViewStatus) – The resource status information.
class azure.mgmt.compute.models.BootDiagnosticsInstanceView(console_screenshot_blob_uri=None, serial_console_log_blob_uri=None)[source]

Bases: msrest.serialization.Model

The instance view of a virtual machine boot diagnostics.

Parameters:
  • console_screenshot_blob_uri (str) – The console screenshot blob URI.
  • serial_console_log_blob_uri (str) – The Linux serial console log blob Uri.
class azure.mgmt.compute.models.VirtualMachineInstanceView(platform_update_domain=None, platform_fault_domain=None, rdp_thumb_print=None, vm_agent=None, disks=None, extensions=None, boot_diagnostics=None, statuses=None)[source]

Bases: msrest.serialization.Model

The instance view of a virtual machine.

Parameters:
class azure.mgmt.compute.models.VirtualMachine(location, tags=None, plan=None, hardware_profile=None, storage_profile=None, os_profile=None, network_profile=None, diagnostics_profile=None, availability_set=None, license_type=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes a Virtual Machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • 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 of VirtualMachineExtension) – The virtual machine child extension resources.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • plan (Plan) – The purchase plan when deploying virtual machine from VM Marketplace images.
  • hardware_profile (HardwareProfile) – The hardware profile.
  • storage_profile (StorageProfile) – The storage profile.
  • os_profile (OSProfile) – The OS profile.
  • network_profile (NetworkProfile) – The network profile.
  • diagnostics_profile (DiagnosticsProfile) – The diagnostics profile.
  • availability_set (SubResource) – The reference Id of the availability set to which the virtual machine belongs.
  • 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.
class azure.mgmt.compute.models.UpgradePolicy(mode=None)[source]

Bases: msrest.serialization.Model

Describes an upgrade policy - automatic or manual.

Parameters:mode (str or UpgradeMode) – The upgrade mode. Possible values include: ‘Automatic’, ‘Manual’
class azure.mgmt.compute.models.ImageOSDisk(os_type, os_state, snapshot=None, managed_disk=None, blob_uri=None, caching=None, disk_size_gb=None)[source]

Bases: msrest.serialization.Model

Describes an Operating System disk.

Parameters:
  • os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • os_state (str or OperatingSystemStateTypes) – 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) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • disk_size_gb (int) – The initial managed disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
class azure.mgmt.compute.models.ImageDataDisk(lun, snapshot=None, managed_disk=None, blob_uri=None, caching=None, disk_size_gb=None)[source]

Bases: msrest.serialization.Model

Describes a data disk.

Parameters:
  • lun (int) – The logical unit number.
  • snapshot (SubResource) – The snapshot.
  • managed_disk (SubResource) – The managedDisk.
  • blob_uri (str) – The Virtual Hard Disk.
  • caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • disk_size_gb (int) – The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
class azure.mgmt.compute.models.ImageStorageProfile(os_disk, data_disks=None)[source]

Bases: msrest.serialization.Model

Describes a storage profile.

Parameters:
class azure.mgmt.compute.models.Image(location, tags=None, source_virtual_machine=None, storage_profile=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes an Image.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – The provisioning state.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
  • storage_profile (ImageStorageProfile) – The storage profile.
class azure.mgmt.compute.models.VirtualMachineScaleSetOSProfile(computer_name_prefix=None, admin_username=None, admin_password=None, custom_data=None, windows_configuration=None, linux_configuration=None, secrets=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set OS profile.

Parameters:
  • computer_name_prefix (str) – The computer name prefix.
  • admin_username (str) – The admin user name.
  • admin_password (str) – The admin user password.
  • 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 of VaultSecretGroup) – The List of certificates for addition to the VM.
class azure.mgmt.compute.models.VirtualMachineScaleSetManagedDiskParameters(storage_account_type=None)[source]

Bases: msrest.serialization.Model

Describes the parameters of a ScaleSet managed disk.

Parameters:storage_account_type (str or StorageAccountTypes) – The Storage Account type. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
class azure.mgmt.compute.models.VirtualMachineScaleSetOSDisk(create_option, name=None, caching=None, os_type=None, image=None, vhd_containers=None, managed_disk=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set operating system disk.

Parameters:
  • name (str) – The disk name.
  • caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • create_option (str or DiskCreateOptionTypes) – The create option. Possible values include: ‘fromImage’, ‘empty’, ‘attach’
  • os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • 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 of str) – The list of virtual hard disk container uris.
  • managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
class azure.mgmt.compute.models.VirtualMachineScaleSetDataDisk(lun, create_option, name=None, caching=None, disk_size_gb=None, managed_disk=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set data disk.

Parameters:
  • name (str) – The disk name.
  • lun (int) – The logical unit number.
  • caching (str or CachingTypes) – The caching type. Possible values include: ‘None’, ‘ReadOnly’, ‘ReadWrite’
  • create_option (str or DiskCreateOptionTypes) – The create option. Possible values include: ‘fromImage’, ‘empty’, ‘attach’
  • disk_size_gb (int) – The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
  • managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
class azure.mgmt.compute.models.VirtualMachineScaleSetStorageProfile(image_reference=None, os_disk=None, data_disks=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set storage profile.

Parameters:
class azure.mgmt.compute.models.ApiEntityReference(id=None)[source]

Bases: msrest.serialization.Model

The API entity reference.

Parameters:id (str) – The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/...
class azure.mgmt.compute.models.VirtualMachineScaleSetIPConfiguration(name, subnet, id=None, application_gateway_backend_address_pools=None, load_balancer_backend_address_pools=None, load_balancer_inbound_nat_pools=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.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.
  • application_gateway_backend_address_pools (list of SubResource) – The application gateway backend address pools.
  • load_balancer_backend_address_pools (list of SubResource) – The load balancer backend address pools.
  • load_balancer_inbound_nat_pools (list of SubResource) – The load balancer inbound nat pools.
class azure.mgmt.compute.models.VirtualMachineScaleSetNetworkConfiguration(name, ip_configurations, id=None, primary=None)[source]

Bases: azure.mgmt.compute.models.sub_resource.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.
  • ip_configurations (list of VirtualMachineScaleSetIPConfiguration) – The virtual machine scale set IP Configuration.
class azure.mgmt.compute.models.VirtualMachineScaleSetNetworkProfile(network_interface_configurations=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set network profile.

Parameters:network_interface_configurations (list of VirtualMachineScaleSetNetworkConfiguration) – The list of network configurations.
class azure.mgmt.compute.models.VirtualMachineScaleSetExtension(name=None, publisher=None, type=None, type_handler_version=None, auto_upgrade_minor_version=None, settings=None, protected_settings=None)[source]

Bases: azure.mgmt.compute.models.sub_resource_read_only.SubResourceReadOnly

Describes a Virtual Machine Scale Set Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • provisioning_state (str) – The provisioning state, which only appears in the response.
Parameters:
  • name (str) – The name of the extension.
  • publisher (str) – The name of the extension handler publisher.
  • type (str) – The type of the extension handler.
  • type_handler_version (str) – The type version of the extension handler.
  • auto_upgrade_minor_version (bool) – Whether the extension handler should be automatically upgraded across minor versions.
  • settings (object) – Json formatted public settings for the extension.
  • protected_settings (object) – Json formatted protected settings for the extension.
class azure.mgmt.compute.models.VirtualMachineScaleSetExtensionProfile(extensions=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set extension profile.

Parameters:extensions (list of VirtualMachineScaleSetExtension) – The virtual machine scale set child extension resources.
class azure.mgmt.compute.models.VirtualMachineScaleSetVMProfile(os_profile=None, storage_profile=None, network_profile=None, extension_profile=None)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set virtual machine profile.

Parameters:
class azure.mgmt.compute.models.VirtualMachineScaleSet(location, tags=None, sku=None, plan=None, upgrade_policy=None, virtual_machine_profile=None, overprovision=None, single_placement_group=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes a Virtual Machine Scale Set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – The provisioning state, which only appears in the response.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • 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.
  • virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.
  • overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
  • single_placement_group (bool) – When true this limits the scale set to a single placement group, of max size 100 virtual machines.
class azure.mgmt.compute.models.VirtualMachineScaleSetVMInstanceIDs(instance_ids=None)[source]

Bases: msrest.serialization.Model

Specifies a list of virtual machine instance IDs from the VM scale set.

Parameters:instance_ids (list of str) – The virtual machine scale set instance ids.
class azure.mgmt.compute.models.VirtualMachineScaleSetVMInstanceRequiredIDs(instance_ids)[source]

Bases: msrest.serialization.Model

Specifies a list of virtual machine instance IDs from the VM scale set.

Parameters:instance_ids (list of str) – The virtual machine scale set instance ids.
class azure.mgmt.compute.models.VirtualMachineStatusCodeCount[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.

Variables:
  • code (str) – The instance view status code.
  • count (int) – The number of instances having a particular status code.
class azure.mgmt.compute.models.VirtualMachineScaleSetInstanceViewStatusesSummary[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 of VirtualMachineStatusCodeCount) – The extensions information.
class azure.mgmt.compute.models.VirtualMachineScaleSetVMExtensionsSummary[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:
class azure.mgmt.compute.models.VirtualMachineScaleSetInstanceView(statuses=None)[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:
Parameters:

statuses (list of InstanceViewStatus) – The resource status information.

class azure.mgmt.compute.models.VirtualMachineScaleSetSkuCapacity[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.models.VirtualMachineScaleSetSku[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:
class azure.mgmt.compute.models.VirtualMachineScaleSetVM(location, tags=None, hardware_profile=None, storage_profile=None, os_profile=None, network_profile=None, diagnostics_profile=None, availability_set=None, license_type=None, plan=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Describes a virtual machine scale set virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • 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 (VirtualMachineInstanceView) – The virtual machine instance view.
  • provisioning_state (str) – The provisioning state, which only appears in the response.
  • resources (list of VirtualMachineExtension) – The virtual machine child extension resources.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • hardware_profile (HardwareProfile) – The hardware profile.
  • storage_profile (StorageProfile) – The storage profile.
  • os_profile (OSProfile) – The OS profile.
  • network_profile (NetworkProfile) – The network profile.
  • diagnostics_profile (DiagnosticsProfile) – The diagnostics profile.
  • availability_set (SubResource) – The reference Id of the availability set to which this virtual machine belongs.
  • license_type (str) – The license type, which is for bring your own license scenario.
  • plan (Plan) – The purchase plan when deploying virtual machine from VM Marketplace images.
class azure.mgmt.compute.models.VirtualMachineScaleSetVMInstanceView(platform_update_domain=None, platform_fault_domain=None, rdp_thumb_print=None, vm_agent=None, disks=None, extensions=None, boot_diagnostics=None, statuses=None, placement_group_id=None)[source]

Bases: msrest.serialization.Model

The instance view of a virtual machine scale set VM.

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.
  • disks (list of DiskInstanceView) – The disks information.
  • extensions (list of VirtualMachineExtensionInstanceView) – The extensions information.
  • boot_diagnostics (BootDiagnosticsInstanceView) – The boot diagnostics.
  • statuses (list of InstanceViewStatus) – The resource status information.
  • placement_group_id (str) – The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
class azure.mgmt.compute.models.ApiErrorBase(code=None, target=None, message=None)[source]

Bases: msrest.serialization.Model

Api error base.

Parameters:
  • code (str) – The error code.
  • target (str) – The target of the particular error.
  • message (str) – The error message.
class azure.mgmt.compute.models.InnerError(exceptiontype=None, errordetail=None)[source]

Bases: msrest.serialization.Model

Inner error details.

Parameters:
  • exceptiontype (str) – The exception type.
  • errordetail (str) – The internal error message or exception dump.
class azure.mgmt.compute.models.ApiError(details=None, innererror=None, code=None, target=None, message=None)[source]

Bases: msrest.serialization.Model

Api error.

Parameters:
  • details (list of 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.models.ComputeLongRunningOperationProperties(output=None)[source]

Bases: msrest.serialization.Model

Compute-specific operation properties, including output.

Parameters:output (object) – Operation output data (raw JSON)
class azure.mgmt.compute.models.Resource(location, tags=None)[source]

Bases: msrest.serialization.Model

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
class azure.mgmt.compute.models.SubResourceReadOnly[source]

Bases: msrest.serialization.Model

SubResourceReadOnly.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:id (str) – Resource Id
class azure.mgmt.compute.models.OperationStatusResponse[source]

Bases: msrest.serialization.Model

Operation status response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.compute.models.ContainerServiceCustomProfile(orchestrator)[source]

Bases: msrest.serialization.Model

Properties to configure a custom container service cluster.

Parameters:orchestrator (str) – The name of the custom orchestrator to use.
class azure.mgmt.compute.models.ContainerServiceServicePrincipalProfile(client_id, secret)[source]

Bases: msrest.serialization.Model

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

Parameters:
  • client_id (str) – The ID for the service principal.
  • secret (str) – The secret password associated with the service principal.
class azure.mgmt.compute.models.ContainerServiceOrchestratorProfile(orchestrator_type)[source]

Bases: msrest.serialization.Model

Profile for the container service orchestrator.

Parameters:orchestrator_type (str or ContainerServiceOchestratorTypes) – The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. Possible values include: ‘Swarm’, ‘DCOS’, ‘Custom’, ‘Kubernetes’
class azure.mgmt.compute.models.ContainerServiceMasterProfile(dns_prefix, count=1)[source]

Bases: msrest.serialization.Model

Profile for the container service master.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:
  • count (int) – Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. Default value: 1 .
  • dns_prefix (str) – DNS prefix to be used to create the FQDN for master.
Variables:

fqdn (str) – FDQN for the master.

class azure.mgmt.compute.models.ContainerServiceAgentPoolProfile(name, vm_size, dns_prefix, count=1)[source]

Bases: msrest.serialization.Model

Profile for the container service agent pool.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:
  • name (str) – Unique name of the agent pool profile in the context of the subscription and resource group.
  • count (int) – Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. . Default value: 1 .
  • vm_size (str or ContainerServiceVMSizeTypes) – Size of agent VMs. Possible values include: ‘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_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_D11_v2’, ‘Standard_D12_v2’, ‘Standard_D13_v2’, ‘Standard_D14_v2’, ‘Standard_G1’, ‘Standard_G2’, ‘Standard_G3’, ‘Standard_G4’, ‘Standard_G5’, ‘Standard_DS1’, ‘Standard_DS2’, ‘Standard_DS3’, ‘Standard_DS4’, ‘Standard_DS11’, ‘Standard_DS12’, ‘Standard_DS13’, ‘Standard_DS14’, ‘Standard_GS1’, ‘Standard_GS2’, ‘Standard_GS3’, ‘Standard_GS4’, ‘Standard_GS5’
  • dns_prefix (str) – DNS prefix to be used to create the FQDN for the agent pool.
Variables:

fqdn (str) – FDQN for the agent pool.

class azure.mgmt.compute.models.ContainerServiceWindowsProfile(admin_username, admin_password)[source]

Bases: msrest.serialization.Model

Profile for Windows VMs in the container service cluster.

Parameters:
  • admin_username (str) – The administrator username to use for Windows VMs.
  • admin_password (str) – The administrator password to use for Windows VMs.
class azure.mgmt.compute.models.ContainerServiceSshPublicKey(key_data)[source]

Bases: msrest.serialization.Model

Contains information about SSH certificate public key data.

Parameters:key_data (str) – Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.
class azure.mgmt.compute.models.ContainerServiceSshConfiguration(public_keys)[source]

Bases: msrest.serialization.Model

SSH configuration for Linux-based VMs running on Azure.

Parameters:public_keys (list of ContainerServiceSshPublicKey) – the list of SSH public keys used to authenticate with Linux-based VMs.
class azure.mgmt.compute.models.ContainerServiceLinuxProfile(admin_username, ssh)[source]

Bases: msrest.serialization.Model

Profile for Linux VMs in the container service cluster.

Parameters:
class azure.mgmt.compute.models.ContainerServiceVMDiagnostics(enabled)[source]

Bases: msrest.serialization.Model

Profile for diagnostics on the container service VMs.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:enabled (bool) – Whether the VM diagnostic agent is provisioned on the VM.
Variables:storage_uri (str) – The URI of the storage account where diagnostics are stored.
class azure.mgmt.compute.models.ContainerServiceDiagnosticsProfile(vm_diagnostics)[source]

Bases: msrest.serialization.Model

ContainerServiceDiagnosticsProfile.

Parameters:vm_diagnostics (ContainerServiceVMDiagnostics) – Profile for the container service VM diagnostic agent.
class azure.mgmt.compute.models.ContainerService(location, master_profile, agent_pool_profiles, linux_profile, tags=None, orchestrator_profile=None, custom_profile=None, service_principal_profile=None, windows_profile=None, diagnostics_profile=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Container service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str) – the current deployment or provisioning state, which only appears in the response.
Parameters:
class azure.mgmt.compute.models.ResourceUpdate(tags=None)[source]

Bases: msrest.serialization.Model

The Resource model definition.

Parameters:tags (dict) – Resource tags
class azure.mgmt.compute.models.ImageDiskReference(id, lun=None)[source]

Bases: msrest.serialization.Model

The source image used for creating the disk.

Parameters:
  • id (str) – A relative uri containing either a Platform Imgage Repository or user image reference.
  • lun (int) – If the disk is created from an image’s data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
class azure.mgmt.compute.models.CreationData(create_option, storage_account_id=None, image_reference=None, source_uri=None, source_resource_id=None)[source]

Bases: msrest.serialization.Model

Data used when creating a disk.

Parameters:
  • create_option (str or DiskCreateOption) – Possible values include: ‘Empty’, ‘Attach’, ‘FromImage’, ‘Import’, ‘Copy’, ‘Restore’
  • 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 creationOption is Import, this is a SAS URI to a blob to be imported into a managed disk. If creationOption is Copy, this is a relative Uri containing the id of the source snapshot to be copied into a managed disk.
  • source_resource_id (str) – If createOption is Copy, this is the ARM id of the source snapshot or disk. If creationOption is Restore, this is the ARM-like id of the source disk restore point.
class azure.mgmt.compute.models.SourceVault(id=None)[source]

Bases: msrest.serialization.Model

The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}.

Parameters:id (str) – Resource Id
class azure.mgmt.compute.models.KeyVaultAndSecretReference(source_vault, secret_url)[source]

Bases: msrest.serialization.Model

Key Vault Secret Url and vault id of the encryption key .

Parameters:
  • source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret
  • secret_url (str) – Url pointing to a key or secret in KeyVault
class azure.mgmt.compute.models.KeyVaultAndKeyReference(source_vault, key_url)[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.

Parameters:
  • source_vault (SourceVault) – Resource id of the KeyVault containing the key or secret
  • key_url (str) – Url pointing to a key or secret in KeyVault
class azure.mgmt.compute.models.EncryptionSettings(enabled=None, disk_encryption_key=None, key_encryption_key=None)[source]

Bases: msrest.serialization.Model

Encryption settings for disk or snapshot.

Parameters:
  • enabled (bool) – 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.
  • 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
class azure.mgmt.compute.models.Disk(location, creation_data, tags=None, account_type=None, os_type=None, disk_size_gb=None, encryption_settings=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Disk resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • time_created (datetime) – The time when the disk was created.
  • owner_id (str) – A relative URI containing the VM id that has the disk attached.
  • provisioning_state (str) – The disk provisioning state.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • account_type (str or StorageAccountTypes) – the storage account type of the disk. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
  • os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • creation_data (CreationData) – 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 VHD 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 (EncryptionSettings) – Encryption settings for disk or snapshot
class azure.mgmt.compute.models.DiskUpdate(tags=None, account_type=None, os_type=None, creation_data=None, disk_size_gb=None, encryption_settings=None)[source]

Bases: azure.mgmt.compute.models.resource_update.ResourceUpdate

Disk update resource.

Parameters:
  • tags (dict) – Resource tags
  • account_type (str or StorageAccountTypes) – the storage account type of the disk. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
  • os_type (str or OperatingSystemTypes) – the Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • creation_data (CreationData) – 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 VHD 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 (EncryptionSettings) – Encryption settings for disk or snapshot
class azure.mgmt.compute.models.GrantAccessData(access, duration_in_seconds)[source]

Bases: msrest.serialization.Model

Data used for requesting a SAS.

Parameters:
  • access (str or AccessLevel) – Possible values include: ‘None’, ‘Read’
  • duration_in_seconds (int) – Time duration in seconds until the SAS access expires.
class azure.mgmt.compute.models.AccessUri[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.models.Snapshot(location, creation_data, tags=None, account_type=None, os_type=None, disk_size_gb=None, encryption_settings=None)[source]

Bases: azure.mgmt.compute.models.resource.Resource

Snapshot resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • time_created (datetime) – The time when the disk was created.
  • owner_id (str) – A relative URI containing the VM id that has the disk attached.
  • provisioning_state (str) – The disk provisioning state.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • account_type (str or StorageAccountTypes) – the storage account type of the disk. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
  • os_type (str or OperatingSystemTypes) – The Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • creation_data (CreationData) – 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 VHD 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 (EncryptionSettings) – Encryption settings for disk or snapshot
class azure.mgmt.compute.models.SnapshotUpdate(tags=None, account_type=None, os_type=None, creation_data=None, disk_size_gb=None, encryption_settings=None)[source]

Bases: azure.mgmt.compute.models.resource_update.ResourceUpdate

Snapshot update resource.

Parameters:
  • tags (dict) – Resource tags
  • account_type (str or StorageAccountTypes) – the storage account type of the disk. Possible values include: ‘Standard_LRS’, ‘Premium_LRS’
  • os_type (str or OperatingSystemTypes) – the Operating System type. Possible values include: ‘Windows’, ‘Linux’
  • creation_data (CreationData) – 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 VHD 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 (EncryptionSettings) – Encryption settings for disk or snapshot
class azure.mgmt.compute.models.AvailabilitySetPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AvailabilitySet object

class azure.mgmt.compute.models.VirtualMachineSizePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualMachineSize object

class azure.mgmt.compute.models.UsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Usage object

class azure.mgmt.compute.models.ImagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Image object

class azure.mgmt.compute.models.VirtualMachinePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualMachine object

class azure.mgmt.compute.models.VirtualMachineScaleSetPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualMachineScaleSet object

class azure.mgmt.compute.models.VirtualMachineScaleSetSkuPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualMachineScaleSetSku object

class azure.mgmt.compute.models.VirtualMachineScaleSetVMPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualMachineScaleSetVM object

class azure.mgmt.compute.models.ContainerServicePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ContainerService object

class azure.mgmt.compute.models.DiskPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Disk object

class azure.mgmt.compute.models.SnapshotPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Snapshot object

class azure.mgmt.compute.models.StatusLevelTypes[source]

Bases: enum.Enum

error = 'Error'
info = 'Info'
warning = 'Warning'
class azure.mgmt.compute.models.OperatingSystemTypes[source]

Bases: enum.Enum

linux = 'Linux'
windows = 'Windows'
class azure.mgmt.compute.models.VirtualMachineSizeTypes[source]

Bases: enum.Enum

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_a2 = 'Standard_A2'
standard_a3 = 'Standard_A3'
standard_a4 = 'Standard_A4'
standard_a5 = 'Standard_A5'
standard_a6 = 'Standard_A6'
standard_a7 = 'Standard_A7'
standard_a8 = 'Standard_A8'
standard_a9 = 'Standard_A9'
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_d1_v2 = 'Standard_D1_v2'
standard_d2 = 'Standard_D2'
standard_d2_v2 = 'Standard_D2_v2'
standard_d3 = 'Standard_D3'
standard_d3_v2 = 'Standard_D3_v2'
standard_d4 = 'Standard_D4'
standard_d4_v2 = 'Standard_D4_v2'
standard_d5_v2 = 'Standard_D5_v2'
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_v2 = 'Standard_DS13_v2'
standard_ds14 = 'Standard_DS14'
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_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_gs5 = 'Standard_GS5'
class azure.mgmt.compute.models.CachingTypes[source]

Bases: enum.Enum

none = 'None'
read_only = 'ReadOnly'
read_write = 'ReadWrite'
class azure.mgmt.compute.models.DiskCreateOptionTypes[source]

Bases: enum.Enum

attach = 'attach'
empty = 'empty'
from_image = 'fromImage'
class azure.mgmt.compute.models.StorageAccountTypes[source]

Bases: enum.Enum

premium_lrs = 'Premium_LRS'
standard_lrs = 'Standard_LRS'
class azure.mgmt.compute.models.PassNames[source]

Bases: enum.Enum

oobe_system = 'oobeSystem'
class azure.mgmt.compute.models.ComponentNames[source]

Bases: enum.Enum

microsoft_windows_shell_setup = 'Microsoft-Windows-Shell-Setup'
class azure.mgmt.compute.models.SettingNames[source]

Bases: enum.Enum

auto_logon = 'AutoLogon'
first_logon_commands = 'FirstLogonCommands'
class azure.mgmt.compute.models.ProtocolTypes[source]

Bases: enum.Enum

http = 'Http'
https = 'Https'
class azure.mgmt.compute.models.UpgradeMode[source]

Bases: enum.Enum

automatic = 'Automatic'
manual = 'Manual'
class azure.mgmt.compute.models.OperatingSystemStateTypes[source]

Bases: enum.Enum

generalized = 'Generalized'
specialized = 'Specialized'
class azure.mgmt.compute.models.VirtualMachineScaleSetSkuScaleType[source]

Bases: enum.Enum

automatic = 'Automatic'
none = 'None'
class azure.mgmt.compute.models.ContainerServiceOchestratorTypes[source]

Bases: enum.Enum

custom = 'Custom'
dcos = 'DCOS'
kubernetes = 'Kubernetes'
swarm = 'Swarm'
class azure.mgmt.compute.models.ContainerServiceVMSizeTypes[source]

Bases: enum.Enum

standard_a0 = 'Standard_A0'
standard_a1 = 'Standard_A1'
standard_a10 = 'Standard_A10'
standard_a11 = 'Standard_A11'
standard_a2 = 'Standard_A2'
standard_a3 = 'Standard_A3'
standard_a4 = 'Standard_A4'
standard_a5 = 'Standard_A5'
standard_a6 = 'Standard_A6'
standard_a7 = 'Standard_A7'
standard_a8 = 'Standard_A8'
standard_a9 = 'Standard_A9'
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_d1_v2 = 'Standard_D1_v2'
standard_d2 = 'Standard_D2'
standard_d2_v2 = 'Standard_D2_v2'
standard_d3 = 'Standard_D3'
standard_d3_v2 = 'Standard_D3_v2'
standard_d4 = 'Standard_D4'
standard_d4_v2 = 'Standard_D4_v2'
standard_d5_v2 = 'Standard_D5_v2'
standard_ds1 = 'Standard_DS1'
standard_ds11 = 'Standard_DS11'
standard_ds12 = 'Standard_DS12'
standard_ds13 = 'Standard_DS13'
standard_ds14 = 'Standard_DS14'
standard_ds2 = 'Standard_DS2'
standard_ds3 = 'Standard_DS3'
standard_ds4 = 'Standard_DS4'
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_gs5 = 'Standard_GS5'
class azure.mgmt.compute.models.DiskCreateOption[source]

Bases: enum.Enum

attach = 'Attach'
copy = 'Copy'
empty = 'Empty'
from_image = 'FromImage'
import_enum = 'Import'
restore = 'Restore'
class azure.mgmt.compute.models.AccessLevel[source]

Bases: enum.Enum

none = 'None'
read = 'Read'
class azure.mgmt.compute.models.InstanceViewTypes[source]

Bases: enum.Enum

instance_view = 'instanceView'