azure.mgmt.compute.v2015_06_15.models module

class azure.mgmt.compute.v2015_06_15.models.AdditionalUnattendContent(*, setting_name: Optional[Union[str, SettingNames]] = None, content: Optional[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.

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

Variables

  • pass_name (str) – The pass name. Currently, the only allowable value is OobeSystem. Default value: “OobeSystem”.

  • component_name (str) – The component name. Currently, the only allowable value is Microsoft- Windows-Shell-Setup. Default value: “Microsoft-Windows-Shell-Setup”.

Parameters

  • 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.

component_name = 'Microsoft-Windows-Shell-Setup'
pass_name = 'OobeSystem'
class azure.mgmt.compute.v2015_06_15.models.ApiEntityReference(*, id: Optional[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.v2015_06_15.models.ApiError(*, details: Optional[List[ApiErrorBase]] = None, innererror: Optional[InnerError] = None, code: Optional[str] = None, target: Optional[str] = None, message: Optional[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.v2015_06_15.models.ApiErrorBase(*, code: Optional[str] = None, target: Optional[str] = None, message: Optional[str] = None, **kwargs)[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.v2015_06_15.models.AvailabilitySet(*, location: str, tags: Optional[Dict[str, str]] = None, platform_update_domain_count: Optional[int] = None, platform_fault_domain_count: Optional[int] = None, virtual_machines: Optional[List[SubResource]] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.models._models_py3.Resource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines. <br><br> For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

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

All required parameters must be populated in order to send to Azure.

Variables
Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • 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.

class azure.mgmt.compute.v2015_06_15.models.AvailabilitySetListResult(*, value: List[AvailabilitySet], next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Availability Set operation response.

All required parameters must be populated in order to send to Azure.

Parameters

  • value (list[AvailabilitySet]) – Required. The list of availability sets.

  • next_link (str) – The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.

class azure.mgmt.compute.v2015_06_15.models.BootDiagnostics(*, enabled: Optional[bool] = None, storage_uri: Optional[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.

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.v2015_06_15.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.

class azure.mgmt.compute.v2015_06_15.models.CachingTypes(value)[source]

Bases: str, enum.Enum

Specifies the caching requirements. <br><br> Possible values are: <br><br> None <br><br> ReadOnly <br><br> ReadWrite <br><br> Default: None for Standard storage. ReadOnly for Premium storage

none = 'None'
read_only = 'ReadOnly'
read_write = 'ReadWrite'
class azure.mgmt.compute.v2015_06_15.models.ComputeLongRunningOperationProperties(*, output: object = None, **kwargs)[source]

Bases: msrest.serialization.Model

Compute-specific operation properties, including output.

Parameters

output (object) – Operation output data (raw JSON).

class azure.mgmt.compute.v2015_06_15.models.DataDisk(*, lun: int, name: str, vhd: azure.mgmt.compute.v2015_06_15.models._models_py3.VirtualHardDisk, create_option: Union[str, DiskCreateOptionTypes], image: Optional[VirtualHardDisk] = None, caching: Optional[Union[str, CachingTypes]] = None, disk_size_gb: Optional[int] = 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) – Required. The disk name.

  • vhd (VirtualHardDisk) – Required. 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”.

  • create_option (str or DiskCreateOptionTypes) – Required. Specifies how the virtual machine should be created.:code:<br><br> Possible values are:<br><br> Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br> FromImage – This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. 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.

class azure.mgmt.compute.v2015_06_15.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.v2015_06_15.models.DiagnosticsProfile(*, boot_diagnostics: Optional[BootDiagnostics] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies the boot diagnostic settings state. <br>:code:`<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.v2015_06_15.models.DiskCreateOptionTypes(value)[source]

Bases: str, enum.Enum

Specifies how the virtual machine should be created.:code:<br><br> Possible values are:<br><br> Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br> FromImage – This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

attach = 'Attach'
empty = 'Empty'
from_image = 'FromImage'
class azure.mgmt.compute.v2015_06_15.models.DiskEncryptionSettings(*, disk_encryption_key: azure.mgmt.compute.v2015_06_15.models._models_py3.KeyVaultSecretReference, key_encryption_key: Optional[KeyVaultKeyReference] = None, enabled: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a Encryption Settings for a Disk.

All required parameters must be populated in order to send to Azure.

Parameters

  • disk_encryption_key (KeyVaultSecretReference) – Required. 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.v2015_06_15.models.DiskInstanceView(*, name: Optional[str] = None, statuses: Optional[List[InstanceViewStatus]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The instance view of the disk.

Parameters
class azure.mgmt.compute.v2015_06_15.models.HardwareProfile(*, vm_size: Optional[Union[str, VirtualMachineSizeTypes]] = 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. <br><br> The available VM sizes depend on region and availability set. For a list of available sizes use these APIs: <br><br> List all available virtual machine sizes in an availability set <br><br> List all available virtual machine sizes in a region <br><br> List all available virtual machine sizes for resizing. 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_DS1”, “Standard_DS2”, “Standard_DS3”, “Standard_DS4”, “Standard_DS11”, “Standard_DS12”, “Standard_DS13”, “Standard_DS14”, “Standard_G1”, “Standard_G2”, “Standard_G3”, “Standard_G4”, “Standard_G5”, “Standard_GS1”, “Standard_GS2”, “Standard_GS3”, “Standard_GS4”, “Standard_GS5”.

class azure.mgmt.compute.v2015_06_15.models.ImageReference(*, publisher: Optional[str] = None, offer: Optional[str] = None, sku: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Parameters

  • 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.v2015_06_15.models.InnerError(*, exceptiontype: Optional[str] = None, errordetail: Optional[str] = None, **kwargs)[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.v2015_06_15.models.InstanceViewStatus(*, code: Optional[str] = None, level: Optional[Union[str, StatusLevelTypes]] = None, display_status: Optional[str] = None, message: Optional[str] = None, time: Optional[datetime.datetime] = 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.v2015_06_15.models.KeyVaultKeyReference(*, key_url: str, source_vault: azure.mgmt.compute.v2015_06_15.models._models_py3.SubResource, **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.v2015_06_15.models.KeyVaultSecretReference(*, secret_url: str, source_vault: azure.mgmt.compute.v2015_06_15.models._models_py3.SubResource, **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.v2015_06_15.models.LinuxConfiguration(*, disable_password_authentication: Optional[bool] = None, ssh: Optional[SshConfiguration] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies the Linux operating system settings on the virtual machine. <br>:code:`<br>`For a list of supported Linux distributions, see `Linux on Azure-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_ <br><br> For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

Parameters

  • disable_password_authentication (bool) – Specifies whether password authentication should be disabled.

  • ssh (SshConfiguration) – Specifies the ssh key configuration for a Linux OS.

class azure.mgmt.compute.v2015_06_15.models.ListUsagesResult(*, value: Optional[List[Usage]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Usages operation response.

Parameters

  • value (list[Usage]) – The list of compute resource usages.

  • next_link (str) – The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

class azure.mgmt.compute.v2015_06_15.models.NetworkInterfaceReference(*, id: Optional[str] = None, primary: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.models._models_py3.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.v2015_06_15.models.NetworkProfile(*, network_interfaces: Optional[List[NetworkInterfaceReference]] = 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.v2015_06_15.models.OSDisk(*, name: str, vhd: azure.mgmt.compute.v2015_06_15.models._models_py3.VirtualHardDisk, create_option: Union[str, DiskCreateOptionTypes], os_type: Optional[Union[str, OperatingSystemTypes]] = None, encryption_settings: Optional[DiskEncryptionSettings] = None, image: Optional[VirtualHardDisk] = None, caching: Optional[Union[str, CachingTypes]] = None, disk_size_gb: Optional[int] = 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.

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) – Required. The disk name.

  • vhd (VirtualHardDisk) – Required. 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”.

  • create_option (str or DiskCreateOptionTypes) – Required. Specifies how the virtual machine should be created.:code:<br><br> Possible values are:<br><br> Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:<br><br> FromImage – This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. 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.

class azure.mgmt.compute.v2015_06_15.models.OSDiskImage(*, operating_system: Union[str, OperatingSystemTypes], **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.v2015_06_15.models.OSProfile(*, computer_name: Optional[str] = None, admin_username: Optional[str] = None, admin_password: Optional[str] = None, custom_data: Optional[str] = None, windows_configuration: Optional[WindowsConfiguration] = None, linux_configuration: Optional[LinuxConfiguration] = None, secrets: Optional[List[VaultSecretGroup]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies the operating system settings for the virtual machine.

Parameters
class azure.mgmt.compute.v2015_06_15.models.OperatingSystemTypes(value)[source]

Bases: str, enum.Enum

The operating system of the osDiskImage.

linux = 'Linux'
windows = 'Windows'
class azure.mgmt.compute.v2015_06_15.models.OperationStatusResponse(**kwargs)[source]

Bases: msrest.serialization.Model

Operation status response.

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

Variables

  • name (str) – Operation ID.

  • status (str) – Operation status.

  • start_time (datetime) – Start time of the operation.

  • end_time (datetime) – End time of the operation.

  • error (ApiError) – Api error.

class azure.mgmt.compute.v2015_06_15.models.Plan(*, name: Optional[str] = None, publisher: Optional[str] = None, product: Optional[str] = None, promotion_code: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

  • name (str) – The plan ID.

  • publisher (str) – The publisher ID.

  • product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

  • promotion_code (str) – The promotion code.

class azure.mgmt.compute.v2015_06_15.models.ProtocolTypes(value)[source]

Bases: str, enum.Enum

Specifies the protocol of listener. <br><br> Possible values are: <br> http <br><br> https

http = 'Http'
https = 'Https'
class azure.mgmt.compute.v2015_06_15.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.

Parameters

  • publisher (str) – Required. The publisher ID.

  • name (str) – Required. The plan ID.

  • product (str) – Required. Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

class azure.mgmt.compute.v2015_06_15.models.Resource(*, location: str, tags: Optional[Dict[str, str]] = 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.

Variables

  • id (str) – Resource Id.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.compute.v2015_06_15.models.SettingNames(value)[source]

Bases: str, enum.Enum

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

auto_logon = 'AutoLogon'
first_logon_commands = 'FirstLogonCommands'
class azure.mgmt.compute.v2015_06_15.models.Sku(*, name: Optional[str] = None, tier: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Parameters

  • name (str) – The sku name.

  • tier (str) – Specifies the tier of virtual machines in a scale set.:code:<br /><br /> Possible Values:<br /><br /> Standard<br /><br /> Basic.

  • capacity (long) – Specifies the number of virtual machines in the scale set.

class azure.mgmt.compute.v2015_06_15.models.SshConfiguration(*, public_keys: Optional[List[SshPublicKey]] = 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.v2015_06_15.models.SshPublicKey(*, path: Optional[str] = None, key_data: Optional[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.

class azure.mgmt.compute.v2015_06_15.models.StatusLevelTypes(value)[source]

Bases: str, enum.Enum

The level code.

error = 'Error'
info = 'Info'
warning = 'Warning'
class azure.mgmt.compute.v2015_06_15.models.StorageProfile(*, image_reference: Optional[ImageReference] = None, os_disk: Optional[OSDisk] = None, data_disks: Optional[List[DataDisk]] = 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.

  • 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.

class azure.mgmt.compute.v2015_06_15.models.SubResource(*, id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

SubResource.

Parameters

id (str) – Resource Id.

class azure.mgmt.compute.v2015_06_15.models.UpdateResource(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Update Resource model definition.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.compute.v2015_06_15.models.UpgradeMode(value)[source]

Bases: str, enum.Enum

Specifies the mode of an upgrade to virtual machines in the scale set.:code:<br /><br /> Possible values are:<br /><br /> Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.:code:<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.

automatic = 'Automatic'
manual = 'Manual'
class azure.mgmt.compute.v2015_06_15.models.UpgradePolicy(*, mode: Optional[Union[str, UpgradeMode]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes an upgrade policy - automatic or manual.

Parameters

mode (str or UpgradeMode) – Specifies the mode of an upgrade to virtual machines in the scale set.:code:<br /><br /> Possible values are:<br /><br /> Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.:code:<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time. Possible values include: “Automatic”, “Manual”.

class azure.mgmt.compute.v2015_06_15.models.Usage(*, current_value: int, limit: int, name: azure.mgmt.compute.v2015_06_15.models._models_py3.UsageName, **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

  • current_value (int) – Required. The current usage of the resource.

  • limit (long) – Required. The maximum permitted usage of the resource.

  • name (UsageName) – Required. The name of the type of usage.

unit = 'Count'
class azure.mgmt.compute.v2015_06_15.models.UsageName(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[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.v2015_06_15.models.VaultCertificate(*, certificate_url: Optional[str] = None, certificate_store: Optional[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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> “data”:”<Base64-encoded- certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file- password>”<br>}.

  • certificate_store (str) – For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br>:code:`<br>`For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted.

class azure.mgmt.compute.v2015_06_15.models.VaultSecretGroup(*, source_vault: Optional[SubResource] = None, vault_certificates: Optional[List[VaultCertificate]] = 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.v2015_06_15.models.VirtualHardDisk(*, uri: Optional[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.v2015_06_15.models.VirtualMachine(*, location: str, tags: Optional[Dict[str, str]] = None, plan: Optional[Plan] = None, hardware_profile: Optional[HardwareProfile] = None, storage_profile: Optional[StorageProfile] = None, os_profile: Optional[OSProfile] = None, network_profile: Optional[NetworkProfile] = None, diagnostics_profile: Optional[DiagnosticsProfile] = None, availability_set: Optional[SubResource] = None, license_type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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
Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • 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.

  • os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.

  • network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.

  • diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. <br>:code:`<br>`Minimum api-version: 2015-06-15.

  • availability_set (SubResource) –

    Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines. <br><br> For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

  • license_type (str) – Specifies that the image or disk that is being used was licensed on- premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Minimum api-version: 2015-06-15.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineAgentInstanceView(*, vm_agent_version: Optional[str] = None, extension_handlers: Optional[List[VirtualMachineExtensionHandlerInstanceView]] = None, statuses: Optional[List[InstanceViewStatus]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters
class azure.mgmt.compute.v2015_06_15.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.

Parameters

  • vhd_prefix (str) – Required. The captured virtual hard disk’s name prefix.

  • destination_container_name (str) – Required. The destination container name.

  • overwrite_vhds (bool) – Required. Specifies whether to overwrite the destination virtual hard disk, in case of conflict.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineCaptureResult(*, id: Optional[str] = None, output: object = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.models._models_py3.SubResource

Resource Id.

Parameters

  • id (str) – Resource Id.

  • output (object) – Operation output data (raw JSON).

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineExtension(*, location: str, tags: Optional[Dict[str, str]] = None, force_update_tag: Optional[str] = None, publisher: Optional[str] = None, type_properties_type: Optional[str] = None, type_handler_version: Optional[str] = None, auto_upgrade_minor_version: Optional[bool] = None, settings: object = None, protected_settings: object = None, instance_view: Optional[VirtualMachineExtensionInstanceView] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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

  • 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) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. 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.

  • type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

  • type_handler_version (str) – Specifies the version of the script handler.

  • auto_upgrade_minor_version (bool) – Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

  • settings (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.v2015_06_15.models.VirtualMachineExtensionHandlerInstanceView(*, type: Optional[str] = None, type_handler_version: Optional[str] = None, status: Optional[InstanceViewStatus] = 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.v2015_06_15.models.VirtualMachineExtensionImage(*, location: str, tags: Optional[Dict[str, str]] = None, operating_system: Optional[str] = None, compute_role: Optional[str] = None, handler_schema: Optional[str] = None, vm_scale_set_enabled: Optional[bool] = None, supports_multiple_extensions: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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

  • id (str) – Resource Id.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. 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.v2015_06_15.models.VirtualMachineExtensionInstanceView(*, name: Optional[str] = None, type: Optional[str] = None, type_handler_version: Optional[str] = None, substatuses: Optional[List[InstanceViewStatus]] = None, statuses: Optional[List[InstanceViewStatus]] = 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.v2015_06_15.models.VirtualMachineExtensionUpdate(*, tags: Optional[Dict[str, str]] = None, force_update_tag: Optional[str] = None, publisher: Optional[str] = None, type: Optional[str] = None, type_handler_version: Optional[str] = None, auto_upgrade_minor_version: Optional[bool] = None, settings: object = None, protected_settings: object = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.models._models_py3.UpdateResource

Describes a Virtual Machine Extension.

Parameters

  • tags (dict[str, str]) – A set of tags. 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.

  • 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.v2015_06_15.models.VirtualMachineImage(*, name: str, location: str, id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, plan: Optional[PurchasePlan] = None, os_disk_image: Optional[OSDiskImage] = None, data_disk_images: Optional[List[DataDiskImage]] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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]) – A set of tags. Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

  • plan (PurchasePlan) – Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

  • os_disk_image (OSDiskImage) – Contains the os disk image information.

  • data_disk_images (list[DataDiskImage]) –

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineImageResource(*, name: str, location: str, id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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]) –

    A set of tags. Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineInstanceView(*, platform_update_domain: Optional[int] = None, platform_fault_domain: Optional[int] = None, rdp_thumb_print: Optional[str] = None, vm_agent: Optional[VirtualMachineAgentInstanceView] = None, disks: Optional[List[DiskInstanceView]] = None, extensions: Optional[List[VirtualMachineExtensionInstanceView]] = None, boot_diagnostics: Optional[BootDiagnosticsInstanceView] = None, statuses: Optional[List[InstanceViewStatus]] = 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.

  • rdp_thumb_print (str) – The Remote desktop certificate thumbprint.

  • vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running 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.v2015_06_15.models.VirtualMachineListResult(*, value: Optional[List[VirtualMachine]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Virtual Machine operation response.

Parameters

  • value (list[VirtualMachine]) – The list of virtual machines.

  • next_link (str) – The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSet(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, upgrade_policy: Optional[UpgradePolicy] = None, virtual_machine_profile: Optional[VirtualMachineScaleSetVMProfile] = None, provisioning_state: Optional[str] = None, over_provision: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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

  • id (str) – Resource Id.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • sku (Sku) – The virtual machine scale set sku.

  • upgrade_policy (UpgradePolicy) – The upgrade policy.

  • virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.

  • provisioning_state (str) – The provisioning state, which only appears in the response.

  • over_provision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetExtension(*, id: Optional[str] = None, name: Optional[str] = None, publisher: Optional[str] = None, type: Optional[str] = None, type_handler_version: Optional[str] = None, auto_upgrade_minor_version: Optional[bool] = None, settings: object = None, protected_settings: object = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.models._models_py3.SubResource

Describes a Virtual Machine Scale Set Extension.

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

Parameters

  • id (str) – Resource Id.

  • 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.

Variables

provisioning_state (str) – The provisioning state, which only appears in the response.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetExtensionProfile(*, extensions: Optional[List[VirtualMachineScaleSetExtension]] = 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.v2015_06_15.models.VirtualMachineScaleSetIPConfiguration(*, name: str, id: Optional[str] = None, subnet: Optional[ApiEntityReference] = None, load_balancer_backend_address_pools: Optional[List[SubResource]] = None, load_balancer_inbound_nat_pools: Optional[List[SubResource]] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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) – The subnet.

  • 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.v2015_06_15.models.VirtualMachineScaleSetInstanceView(*, statuses: Optional[List[InstanceViewStatus]] = 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
Parameters

statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2015_06_15.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.v2015_06_15.models.VirtualMachineScaleSetListResult(*, value: Optional[List[VirtualMachineScaleSet]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Virtual Machine operation response.

Parameters

  • value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets.

  • next_link (str) – The URI to fetch the next page of virtual machine scale sets. Call ListNext() with this to fetch the next page of virtual machine scale sets.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetListSkusResult(*, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Virtual Machine Scale Set List Skus operation response.

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

Variables

value (list[VirtualMachineScaleSetSku]) – The list of skus available for the virtual machine scale set.

Parameters

next_link (str) – The URI to fetch the next page of skus available for the virtual machine scale set. Call ListNext() with this to fetch the next page of skus available for the virtual machine scale set.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetListWithLinkResult(*, value: Optional[List[VirtualMachineScaleSet]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Virtual Machine operation response.

Parameters

  • value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets.

  • next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetNetworkConfiguration(*, name: str, id: Optional[str] = None, primary: Optional[bool] = None, ip_configurations: Optional[List[VirtualMachineScaleSetIPConfiguration]] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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) – Whether this is a primary NIC on a virtual machine.

  • ip_configurations (list[VirtualMachineScaleSetIPConfiguration]) – The virtual machine scale set IP Configuration.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetNetworkProfile(*, network_interface_configurations: Optional[List[VirtualMachineScaleSetNetworkConfiguration]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set network profile.

Parameters

network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetOSDisk(*, name: str, create_option: Union[str, DiskCreateOptionTypes], caching: Optional[Union[str, CachingTypes]] = None, os_type: Optional[Union[str, OperatingSystemTypes]] = None, image: Optional[VirtualHardDisk] = None, vhd_containers: Optional[List[str]] = 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) – Required. 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”.

  • create_option (str or DiskCreateOptionTypes) – Required. Specifies how the virtual machines in the scale set should be created.:code:<br><br> The only allowed value is: FromImage – This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: “FromImage”, “Empty”, “Attach”.

  • 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) – 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.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetOSProfile(*, computer_name_prefix: Optional[str] = None, admin_username: Optional[str] = None, admin_password: Optional[str] = None, custom_data: Optional[str] = None, windows_configuration: Optional[WindowsConfiguration] = None, linux_configuration: Optional[LinuxConfiguration] = None, secrets: Optional[List[VaultSecretGroup]] = 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<br><li> For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure.

  • admin_password (str) –

    Specifies the password of the administrator account. <br><br> Minimum-length (Windows): 8 characters <br><br> Minimum-length (Linux): 6 characters <br><br> Max-length (Windows): 123 characters <br><br> Max-length (Linux): 72 characters <br><br> Complexity requirements: 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>`Has upper characters :code:`<br> Has a digit <br> Has a special character (Regex match [W_]) <br><br> Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” <br><br> For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM <br><br> For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.

  • custom_data (str) – 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.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models.VirtualMachineScaleSetSkuScaleType(value)[source]

Bases: str, enum.Enum

The scale type applicable to the sku.

automatic = 'Automatic'
none = 'None'
class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetStorageProfile(*, image_reference: Optional[ImageReference] = None, os_disk: Optional[VirtualMachineScaleSetOSDisk] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set storage profile.

Parameters
class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetVM(*, location: str, tags: Optional[Dict[str, str]] = None, plan: Optional[Plan] = None, hardware_profile: Optional[HardwareProfile] = None, storage_profile: Optional[StorageProfile] = None, os_profile: Optional[OSProfile] = None, network_profile: Optional[NetworkProfile] = None, diagnostics_profile: Optional[DiagnosticsProfile] = None, availability_set: Optional[SubResource] = None, provisioning_state: Optional[str] = None, license_type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.compute.v2015_06_15.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
Parameters

  • location (str) – Required. Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • 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.

  • os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.

  • network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.

  • diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. <br>:code:`<br>`Minimum api-version: 2015-06-15.

  • availability_set (SubResource) –

    Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines. <br><br> For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

  • provisioning_state (str) – The provisioning state, which only appears in the response.

  • license_type (str) –

    Specifies that the image or disk that is being used was licensed on- premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Minimum api-version: 2015-06-15.

class azure.mgmt.compute.v2015_06_15.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
class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetVMInstanceIDs(*, instance_ids: Optional[List[str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters

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.v2015_06_15.models.VirtualMachineScaleSetVMInstanceRequiredIDs(*, instance_ids: List[str], **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.

Parameters

instance_ids (list[str]) – Required. The virtual machine scale set instance ids.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetVMInstanceView(*, platform_update_domain: Optional[int] = None, platform_fault_domain: Optional[int] = None, rdp_thumb_print: Optional[str] = None, vm_agent: Optional[VirtualMachineAgentInstanceView] = None, disks: Optional[List[DiskInstanceView]] = None, extensions: Optional[List[VirtualMachineExtensionInstanceView]] = None, boot_diagnostics: Optional[BootDiagnosticsInstanceView] = None, statuses: Optional[List[InstanceViewStatus]] = None, **kwargs)[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[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.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetVMListResult(*, value: Optional[List[VirtualMachineScaleSetVM]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Virtual Machine Scale Set VMs operation response.

Parameters

  • value (list[VirtualMachineScaleSetVM]) – The list of virtual machine scale sets VMs.

  • next_link (str) – The URI to fetch the next page of virtual machine scale sets VMs. Call ListNext() with this to fetch the next page of virtual machine scale sets VMs.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineScaleSetVMProfile(*, os_profile: Optional[VirtualMachineScaleSetOSProfile] = None, storage_profile: Optional[VirtualMachineScaleSetStorageProfile] = None, network_profile: Optional[VirtualMachineScaleSetNetworkProfile] = None, extension_profile: Optional[VirtualMachineScaleSetExtensionProfile] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a virtual machine scale set virtual machine profile.

Parameters
class azure.mgmt.compute.v2015_06_15.models.VirtualMachineSize(*, name: Optional[str] = None, number_of_cores: Optional[int] = None, os_disk_size_in_mb: Optional[int] = None, resource_disk_size_in_mb: Optional[int] = None, memory_in_mb: Optional[int] = None, max_data_disk_count: Optional[int] = None, **kwargs)[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.v2015_06_15.models.VirtualMachineSizeListResult(*, value: Optional[List[VirtualMachineSize]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The List Virtual Machine operation response.

Parameters

value (list[VirtualMachineSize]) – The list of virtual machine sizes.

class azure.mgmt.compute.v2015_06_15.models.VirtualMachineSizeTypes(value)[source]

Bases: str, enum.Enum

Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines. <br><br> The available VM sizes depend on region and availability set. For a list of available sizes use these APIs: <br><br> List all available virtual machine sizes in an availability set <br><br> List all available virtual machine sizes in a region <br><br> List all available virtual machine sizes for resizing

basic_a0 = 'Basic_A0'
basic_a1 = 'Basic_A1'
basic_a2 = 'Basic_A2'
basic_a3 = 'Basic_A3'
basic_a4 = 'Basic_A4'
standard_a0 = 'Standard_A0'
standard_a1 = 'Standard_A1'
standard_a10 = 'Standard_A10'
standard_a11 = 'Standard_A11'
standard_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.v2015_06_15.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.

Variables

  • code (str) – The instance view status code.

  • count (int) – The number of instances having a particular status code.

class azure.mgmt.compute.v2015_06_15.models.WinRMConfiguration(*, listeners: Optional[List[WinRMListener]] = 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.v2015_06_15.models.WinRMListener(*, protocol: Optional[Union[str, ProtocolTypes]] = None, certificate_url: Optional[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. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> “data”:”<Base64-encoded- certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file- password>”<br>}.

class azure.mgmt.compute.v2015_06_15.models.WindowsConfiguration(*, provision_vm_agent: Optional[bool] = None, enable_automatic_updates: Optional[bool] = None, time_zone: Optional[str] = None, additional_unattend_content: Optional[List[AdditionalUnattendContent]] = None, win_rm: Optional[WinRMConfiguration] = 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 virtual machine is enabled for automatic updates.

  • 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.