# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
from typing import Dict, List, Optional, Union
import msrest.serialization
from ._compute_management_client_enums import *
[docs]class AccessUri(msrest.serialization.Model):
"""A disk access SAS uri.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar access_sas: A SAS uri for accessing a disk.
:vartype access_sas: str
"""
_validation = {
'access_sas': {'readonly': True},
}
_attribute_map = {
'access_sas': {'key': 'properties.output.accessSAS', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(AccessUri, self).__init__(**kwargs)
self.access_sas = None
[docs]class AdditionalUnattendContent(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.
:ivar pass_name: The pass name. Currently, the only allowable value is OobeSystem. Default
value: "OobeSystem".
:vartype pass_name: str
:ivar component_name: The component name. Currently, the only allowable value is Microsoft-
Windows-Shell-Setup. Default value: "Microsoft-Windows-Shell-Setup".
:vartype component_name: str
:param setting_name: Specifies the name of the setting to which the content applies. Possible
values are: FirstLogonCommands and AutoLogon. Possible values include: "AutoLogon",
"FirstLogonCommands".
:type setting_name: str or ~azure.mgmt.compute.v2016_04_30_preview.models.SettingNames
:param content: Specifies the XML formatted content that is added to the unattend.xml file for
the specified path and component. The XML must be less than 4KB and must include the root
element for the setting or feature that is being inserted.
:type content: str
"""
_validation = {
'pass_name': {'constant': True},
'component_name': {'constant': True},
}
_attribute_map = {
'pass_name': {'key': 'passName', 'type': 'str'},
'component_name': {'key': 'componentName', 'type': 'str'},
'setting_name': {'key': 'settingName', 'type': 'str'},
'content': {'key': 'content', 'type': 'str'},
}
pass_name = "OobeSystem"
component_name = "Microsoft-Windows-Shell-Setup"
def __init__(
self,
*,
setting_name: Optional[Union[str, "SettingNames"]] = None,
content: Optional[str] = None,
**kwargs
):
super(AdditionalUnattendContent, self).__init__(**kwargs)
self.setting_name = setting_name
self.content = content
[docs]class ApiEntityReference(msrest.serialization.Model):
"""The API entity reference.
:param id: The ARM resource id in the form of
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
:type id: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
**kwargs
):
super(ApiEntityReference, self).__init__(**kwargs)
self.id = id
[docs]class ApiError(msrest.serialization.Model):
"""Api error.
:param details: The Api error details.
:type details: list[~azure.mgmt.compute.v2016_04_30_preview.models.ApiErrorBase]
:param innererror: The Api inner error.
:type innererror: ~azure.mgmt.compute.v2016_04_30_preview.models.InnerError
:param code: The error code.
:type code: str
:param target: The target of the particular error.
:type target: str
:param message: The error message.
:type message: str
"""
_attribute_map = {
'details': {'key': 'details', 'type': '[ApiErrorBase]'},
'innererror': {'key': 'innererror', 'type': 'InnerError'},
'code': {'key': 'code', 'type': 'str'},
'target': {'key': 'target', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(
self,
*,
details: Optional[List["ApiErrorBase"]] = None,
innererror: Optional["InnerError"] = None,
code: Optional[str] = None,
target: Optional[str] = None,
message: Optional[str] = None,
**kwargs
):
super(ApiError, self).__init__(**kwargs)
self.details = details
self.innererror = innererror
self.code = code
self.target = target
self.message = message
[docs]class ApiErrorBase(msrest.serialization.Model):
"""Api error base.
:param code: The error code.
:type code: str
:param target: The target of the particular error.
:type target: str
:param message: The error message.
:type message: str
"""
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'target': {'key': 'target', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(
self,
*,
code: Optional[str] = None,
target: Optional[str] = None,
message: Optional[str] = None,
**kwargs
):
super(ApiErrorBase, self).__init__(**kwargs)
self.code = code
self.target = target
self.message = message
[docs]class Resource(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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
[docs]class AvailabilitySet(Resource):
"""Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see `Manage the availability of virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_. :code:`<br>`:code:`<br>` For more information on Azure planned maintenance, see `Planned maintenance for virtual machines in Azure <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_ :code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param sku: Sku of the availability set.
:type sku: ~azure.mgmt.compute.v2016_04_30_preview.models.Sku
:param platform_update_domain_count: Update Domain count.
:type platform_update_domain_count: int
:param platform_fault_domain_count: Fault Domain count.
:type platform_fault_domain_count: int
:param virtual_machines: A list of references to all virtual machines in the availability set.
:type virtual_machines: list[~azure.mgmt.compute.v2016_04_30_preview.models.SubResource]
:ivar statuses: The resource status information.
:vartype statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
:param managed: If the availability set supports managed disks.
:type managed: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'statuses': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'platform_update_domain_count': {'key': 'properties.platformUpdateDomainCount', 'type': 'int'},
'platform_fault_domain_count': {'key': 'properties.platformFaultDomainCount', 'type': 'int'},
'virtual_machines': {'key': 'properties.virtualMachines', 'type': '[SubResource]'},
'statuses': {'key': 'properties.statuses', 'type': '[InstanceViewStatus]'},
'managed': {'key': 'properties.managed', 'type': 'bool'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
platform_update_domain_count: Optional[int] = None,
platform_fault_domain_count: Optional[int] = None,
virtual_machines: Optional[List["SubResource"]] = None,
managed: Optional[bool] = None,
**kwargs
):
super(AvailabilitySet, self).__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.platform_update_domain_count = platform_update_domain_count
self.platform_fault_domain_count = platform_fault_domain_count
self.virtual_machines = virtual_machines
self.statuses = None
self.managed = managed
[docs]class AvailabilitySetListResult(msrest.serialization.Model):
"""The List Availability Set operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of availability sets.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.AvailabilitySet]
:param next_link: The URI to fetch the next page of AvailabilitySets. Call ListNext() with this
URI to fetch the next page of AvailabilitySets.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[AvailabilitySet]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["AvailabilitySet"],
next_link: Optional[str] = None,
**kwargs
):
super(AvailabilitySetListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class BootDiagnostics(msrest.serialization.Model):
"""Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a screenshot of the VM from the hypervisor.
:param enabled: Whether boot diagnostics should be enabled on the Virtual Machine.
:type enabled: bool
:param storage_uri: Uri of the storage account to use for placing the console output and
screenshot.
:type storage_uri: str
"""
_attribute_map = {
'enabled': {'key': 'enabled', 'type': 'bool'},
'storage_uri': {'key': 'storageUri', 'type': 'str'},
}
def __init__(
self,
*,
enabled: Optional[bool] = None,
storage_uri: Optional[str] = None,
**kwargs
):
super(BootDiagnostics, self).__init__(**kwargs)
self.enabled = enabled
self.storage_uri = storage_uri
[docs]class BootDiagnosticsInstanceView(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.
:ivar console_screenshot_blob_uri: The console screenshot blob URI.
:vartype console_screenshot_blob_uri: str
:ivar serial_console_log_blob_uri: The Linux serial console log blob Uri.
:vartype serial_console_log_blob_uri: str
"""
_validation = {
'console_screenshot_blob_uri': {'readonly': True},
'serial_console_log_blob_uri': {'readonly': True},
}
_attribute_map = {
'console_screenshot_blob_uri': {'key': 'consoleScreenshotBlobUri', 'type': 'str'},
'serial_console_log_blob_uri': {'key': 'serialConsoleLogBlobUri', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(BootDiagnosticsInstanceView, self).__init__(**kwargs)
self.console_screenshot_blob_uri = None
self.serial_console_log_blob_uri = None
[docs]class ComputeLongRunningOperationProperties(msrest.serialization.Model):
"""Compute-specific operation properties, including output.
:param output: Operation output data (raw JSON).
:type output: object
"""
_attribute_map = {
'output': {'key': 'output', 'type': 'object'},
}
def __init__(
self,
*,
output: Optional[object] = None,
**kwargs
):
super(ComputeLongRunningOperationProperties, self).__init__(**kwargs)
self.output = output
[docs]class CreationData(msrest.serialization.Model):
"""Data used when creating a disk.
All required parameters must be populated in order to send to Azure.
:param create_option: Required. This enumerates the possible sources of a disk's creation.
Possible values include: "Empty", "Attach", "FromImage", "Import", "Copy", "Restore".
:type create_option: str or ~azure.mgmt.compute.v2016_04_30_preview.models.DiskCreateOption
:param storage_account_id: If createOption is Import, the Azure Resource Manager identifier of
the storage account containing the blob to import as a disk. Required only if the blob is in a
different subscription.
:type storage_account_id: str
:param image_reference: Disk source information.
:type image_reference: ~azure.mgmt.compute.v2016_04_30_preview.models.ImageDiskReference
:param source_uri: If createOption is Import, this is a SAS URI to a blob to be imported into a
managed disk. If createOption is Copy, this is a relative Uri containing the id of the source
snapshot to be copied into a managed disk.
:type source_uri: str
:param source_resource_id: If createOption is Copy, this is the ARM id of the source snapshot
or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.
:type source_resource_id: str
"""
_validation = {
'create_option': {'required': True},
}
_attribute_map = {
'create_option': {'key': 'createOption', 'type': 'str'},
'storage_account_id': {'key': 'storageAccountId', 'type': 'str'},
'image_reference': {'key': 'imageReference', 'type': 'ImageDiskReference'},
'source_uri': {'key': 'sourceUri', 'type': 'str'},
'source_resource_id': {'key': 'sourceResourceId', 'type': 'str'},
}
def __init__(
self,
*,
create_option: Union[str, "DiskCreateOption"],
storage_account_id: Optional[str] = None,
image_reference: Optional["ImageDiskReference"] = None,
source_uri: Optional[str] = None,
source_resource_id: Optional[str] = None,
**kwargs
):
super(CreationData, self).__init__(**kwargs)
self.create_option = create_option
self.storage_account_id = storage_account_id
self.image_reference = image_reference
self.source_uri = source_uri
self.source_resource_id = source_resource_id
[docs]class DataDisk(msrest.serialization.Model):
"""Describes a data disk.
All required parameters must be populated in order to send to Azure.
:param lun: 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.
:type lun: int
:param name: The disk name.
:type name: str
:param vhd: The virtual hard disk.
:type vhd: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualHardDisk
:param image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:type image: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualHardDisk
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param create_option: Required. Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Possible values include: "FromImage", "Empty", "Attach".
:type create_option: str or
~azure.mgmt.compute.v2016_04_30_preview.models.DiskCreateOptionTypes
:param disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:type disk_size_gb: int
:param managed_disk: The managed disk parameters.
:type managed_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.ManagedDiskParameters
"""
_validation = {
'lun': {'required': True},
'create_option': {'required': True},
}
_attribute_map = {
'lun': {'key': 'lun', 'type': 'int'},
'name': {'key': 'name', 'type': 'str'},
'vhd': {'key': 'vhd', 'type': 'VirtualHardDisk'},
'image': {'key': 'image', 'type': 'VirtualHardDisk'},
'caching': {'key': 'caching', 'type': 'str'},
'create_option': {'key': 'createOption', 'type': 'str'},
'disk_size_gb': {'key': 'diskSizeGB', 'type': 'int'},
'managed_disk': {'key': 'managedDisk', 'type': 'ManagedDiskParameters'},
}
def __init__(
self,
*,
lun: int,
create_option: Union[str, "DiskCreateOptionTypes"],
name: Optional[str] = None,
vhd: Optional["VirtualHardDisk"] = None,
image: Optional["VirtualHardDisk"] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["ManagedDiskParameters"] = None,
**kwargs
):
super(DataDisk, self).__init__(**kwargs)
self.lun = lun
self.name = name
self.vhd = vhd
self.image = image
self.caching = caching
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
[docs]class DataDiskImage(msrest.serialization.Model):
"""Contains the data disk images information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar lun: Specifies the logical unit number of the data disk. This value is used to identify
data disks within the VM and therefore must be unique for each data disk attached to a VM.
:vartype lun: int
"""
_validation = {
'lun': {'readonly': True},
}
_attribute_map = {
'lun': {'key': 'lun', 'type': 'int'},
}
def __init__(
self,
**kwargs
):
super(DataDiskImage, self).__init__(**kwargs)
self.lun = None
[docs]class DiagnosticsProfile(msrest.serialization.Model):
"""Specifies the boot diagnostic settings state. :code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:param boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:type boot_diagnostics: ~azure.mgmt.compute.v2016_04_30_preview.models.BootDiagnostics
"""
_attribute_map = {
'boot_diagnostics': {'key': 'bootDiagnostics', 'type': 'BootDiagnostics'},
}
def __init__(
self,
*,
boot_diagnostics: Optional["BootDiagnostics"] = None,
**kwargs
):
super(DiagnosticsProfile, self).__init__(**kwargs)
self.boot_diagnostics = boot_diagnostics
[docs]class Disk(Resource):
"""Disk resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param account_type: the storage account type of the disk. Possible values include:
"Standard_LRS", "Premium_LRS".
:type account_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
:ivar time_created: The time when the disk was created.
:vartype time_created: ~datetime.datetime
:param os_type: The Operating System type. Possible values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param creation_data: Disk source information. CreationData information cannot be changed after
the disk has been created.
:type creation_data: ~azure.mgmt.compute.v2016_04_30_preview.models.CreationData
:param disk_size_gb: 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.
:type disk_size_gb: int
:param encryption_settings: Encryption settings for disk or snapshot.
:type encryption_settings: ~azure.mgmt.compute.v2016_04_30_preview.models.EncryptionSettings
:ivar owner_id: A relative URI containing the VM id that has the disk attached.
:vartype owner_id: str
:ivar provisioning_state: The disk provisioning state.
:vartype provisioning_state: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'time_created': {'readonly': True},
'owner_id': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'time_created': {'key': 'properties.timeCreated', 'type': 'iso-8601'},
'os_type': {'key': 'properties.osType', 'type': 'str'},
'creation_data': {'key': 'properties.creationData', 'type': 'CreationData'},
'disk_size_gb': {'key': 'properties.diskSizeGB', 'type': 'int'},
'encryption_settings': {'key': 'properties.encryptionSettings', 'type': 'EncryptionSettings'},
'owner_id': {'key': 'properties.ownerId', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
creation_data: Optional["CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings: Optional["EncryptionSettings"] = None,
**kwargs
):
super(Disk, self).__init__(location=location, tags=tags, **kwargs)
self.account_type = account_type
self.time_created = None
self.os_type = os_type
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.encryption_settings = encryption_settings
self.owner_id = None
self.provisioning_state = None
[docs]class DiskEncryptionSettings(msrest.serialization.Model):
"""Describes a Encryption Settings for a Disk.
:param disk_encryption_key: Specifies the location of the disk encryption key, which is a Key
Vault Secret.
:type disk_encryption_key:
~azure.mgmt.compute.v2016_04_30_preview.models.KeyVaultSecretReference
:param key_encryption_key: Specifies the location of the key encryption key in Key Vault.
:type key_encryption_key: ~azure.mgmt.compute.v2016_04_30_preview.models.KeyVaultKeyReference
:param enabled: Specifies whether disk encryption should be enabled on the virtual machine.
:type enabled: bool
"""
_attribute_map = {
'disk_encryption_key': {'key': 'diskEncryptionKey', 'type': 'KeyVaultSecretReference'},
'key_encryption_key': {'key': 'keyEncryptionKey', 'type': 'KeyVaultKeyReference'},
'enabled': {'key': 'enabled', 'type': 'bool'},
}
def __init__(
self,
*,
disk_encryption_key: Optional["KeyVaultSecretReference"] = None,
key_encryption_key: Optional["KeyVaultKeyReference"] = None,
enabled: Optional[bool] = None,
**kwargs
):
super(DiskEncryptionSettings, self).__init__(**kwargs)
self.disk_encryption_key = disk_encryption_key
self.key_encryption_key = key_encryption_key
self.enabled = enabled
[docs]class DiskInstanceView(msrest.serialization.Model):
"""The instance view of the disk.
:param name: The disk name.
:type name: str
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
}
def __init__(
self,
*,
name: Optional[str] = None,
statuses: Optional[List["InstanceViewStatus"]] = None,
**kwargs
):
super(DiskInstanceView, self).__init__(**kwargs)
self.name = name
self.statuses = statuses
[docs]class DiskList(msrest.serialization.Model):
"""The List Disks operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. A list of disks.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.Disk]
:param next_link: the uri to fetch the next page of disks. Call ListNext() with this to fetch
the next page of disks.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Disk]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["Disk"],
next_link: Optional[str] = None,
**kwargs
):
super(DiskList, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ResourceUpdate(msrest.serialization.Model):
"""The Resource model definition.
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
super(ResourceUpdate, self).__init__(**kwargs)
self.tags = tags
[docs]class DiskUpdate(ResourceUpdate):
"""Disk update resource.
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param account_type: the storage account type of the disk. Possible values include:
"Standard_LRS", "Premium_LRS".
:type account_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
:param os_type: the Operating System type. Possible values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param creation_data: disk source information. CreationData information cannot be changed after
the disk has been created.
:type creation_data: ~azure.mgmt.compute.v2016_04_30_preview.models.CreationData
:param disk_size_gb: 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.
:type disk_size_gb: int
:param encryption_settings: Encryption settings for disk or snapshot.
:type encryption_settings: ~azure.mgmt.compute.v2016_04_30_preview.models.EncryptionSettings
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'os_type': {'key': 'properties.osType', 'type': 'str'},
'creation_data': {'key': 'properties.creationData', 'type': 'CreationData'},
'disk_size_gb': {'key': 'properties.diskSizeGB', 'type': 'int'},
'encryption_settings': {'key': 'properties.encryptionSettings', 'type': 'EncryptionSettings'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
creation_data: Optional["CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings: Optional["EncryptionSettings"] = None,
**kwargs
):
super(DiskUpdate, self).__init__(tags=tags, **kwargs)
self.account_type = account_type
self.os_type = os_type
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.encryption_settings = encryption_settings
[docs]class EncryptionSettings(msrest.serialization.Model):
"""Encryption settings for disk or snapshot.
:param enabled: Set this flag to true and provide DiskEncryptionKey and optional
KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and
KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object,
the existing settings remain unchanged.
:type enabled: bool
:param disk_encryption_key: Key Vault Secret Url and vault id of the disk encryption key.
:type disk_encryption_key:
~azure.mgmt.compute.v2016_04_30_preview.models.KeyVaultAndSecretReference
:param key_encryption_key: Key Vault Key Url and vault id of the key encryption key.
:type key_encryption_key:
~azure.mgmt.compute.v2016_04_30_preview.models.KeyVaultAndKeyReference
"""
_attribute_map = {
'enabled': {'key': 'enabled', 'type': 'bool'},
'disk_encryption_key': {'key': 'diskEncryptionKey', 'type': 'KeyVaultAndSecretReference'},
'key_encryption_key': {'key': 'keyEncryptionKey', 'type': 'KeyVaultAndKeyReference'},
}
def __init__(
self,
*,
enabled: Optional[bool] = None,
disk_encryption_key: Optional["KeyVaultAndSecretReference"] = None,
key_encryption_key: Optional["KeyVaultAndKeyReference"] = None,
**kwargs
):
super(EncryptionSettings, self).__init__(**kwargs)
self.enabled = enabled
self.disk_encryption_key = disk_encryption_key
self.key_encryption_key = key_encryption_key
[docs]class GrantAccessData(msrest.serialization.Model):
"""Data used for requesting a SAS.
All required parameters must be populated in order to send to Azure.
:param access: Required. Possible values include: "None", "Read".
:type access: str or ~azure.mgmt.compute.v2016_04_30_preview.models.AccessLevel
:param duration_in_seconds: Required. Time duration in seconds until the SAS access expires.
:type duration_in_seconds: int
"""
_validation = {
'access': {'required': True},
'duration_in_seconds': {'required': True},
}
_attribute_map = {
'access': {'key': 'access', 'type': 'str'},
'duration_in_seconds': {'key': 'durationInSeconds', 'type': 'int'},
}
def __init__(
self,
*,
access: Union[str, "AccessLevel"],
duration_in_seconds: int,
**kwargs
):
super(GrantAccessData, self).__init__(**kwargs)
self.access = access
self.duration_in_seconds = duration_in_seconds
[docs]class HardwareProfile(msrest.serialization.Model):
"""Specifies the hardware settings for the virtual machine.
:param vm_size: Specifies the size of the virtual machine. For more information about virtual
machine sizes, see `Sizes for virtual machines <https://docs.microsoft.com/azure/virtual-
machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-
machines%2fwindows%2ftoc.json>`_. :code:`<br>`:code:`<br>` The available VM sizes depend on
region and availability set. For a list of available sizes use these APIs:
:code:`<br>`:code:`<br>` `List all available virtual machine sizes in an availability set
<virtualmachines-list-sizes-availability-set.md>`_ :code:`<br>`:code:`<br>` `List all available
virtual machine sizes in a region <virtualmachines-list-sizes-region.md>`_
:code:`<br>`:code:`<br>` `List all available virtual machine sizes for resizing
<virtualmachines-list-sizes-for-resizing.md>`_. 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".
:type vm_size: str or ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineSizeTypes
"""
_attribute_map = {
'vm_size': {'key': 'vmSize', 'type': 'str'},
}
def __init__(
self,
*,
vm_size: Optional[Union[str, "VirtualMachineSizeTypes"]] = None,
**kwargs
):
super(HardwareProfile, self).__init__(**kwargs)
self.vm_size = vm_size
[docs]class Image(Resource):
"""The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param source_virtual_machine: The source virtual machine from which Image is created.
:type source_virtual_machine: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param storage_profile: Specifies the storage settings for the virtual machine disks.
:type storage_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.ImageStorageProfile
:ivar provisioning_state: The provisioning state.
:vartype provisioning_state: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'source_virtual_machine': {'key': 'properties.sourceVirtualMachine', 'type': 'SubResource'},
'storage_profile': {'key': 'properties.storageProfile', 'type': 'ImageStorageProfile'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
source_virtual_machine: Optional["SubResource"] = None,
storage_profile: Optional["ImageStorageProfile"] = None,
**kwargs
):
super(Image, self).__init__(location=location, tags=tags, **kwargs)
self.source_virtual_machine = source_virtual_machine
self.storage_profile = storage_profile
self.provisioning_state = None
[docs]class ImageDataDisk(msrest.serialization.Model):
"""Describes a data disk.
All required parameters must be populated in order to send to Azure.
:param lun: 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.
:type lun: int
:param snapshot: The snapshot.
:type snapshot: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param managed_disk: The managedDisk.
:type managed_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param blob_uri: The Virtual Hard Disk.
:type blob_uri: str
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:type disk_size_gb: int
"""
_validation = {
'lun': {'required': True},
}
_attribute_map = {
'lun': {'key': 'lun', 'type': 'int'},
'snapshot': {'key': 'snapshot', 'type': 'SubResource'},
'managed_disk': {'key': 'managedDisk', 'type': 'SubResource'},
'blob_uri': {'key': 'blobUri', 'type': 'str'},
'caching': {'key': 'caching', 'type': 'str'},
'disk_size_gb': {'key': 'diskSizeGB', 'type': 'int'},
}
def __init__(
self,
*,
lun: int,
snapshot: Optional["SubResource"] = None,
managed_disk: Optional["SubResource"] = None,
blob_uri: Optional[str] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
**kwargs
):
super(ImageDataDisk, self).__init__(**kwargs)
self.lun = lun
self.snapshot = snapshot
self.managed_disk = managed_disk
self.blob_uri = blob_uri
self.caching = caching
self.disk_size_gb = disk_size_gb
[docs]class ImageDiskReference(msrest.serialization.Model):
"""The source image used for creating the disk.
All required parameters must be populated in order to send to Azure.
:param id: Required. A relative uri containing either a Platform Image Repository or user image
reference.
:type id: str
:param lun: If the disk is created from an image's data disk, this is an index that indicates
which of the data disks in the image to use. For OS disks, this field is null.
:type lun: int
"""
_validation = {
'id': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'lun': {'key': 'lun', 'type': 'int'},
}
def __init__(
self,
*,
id: str,
lun: Optional[int] = None,
**kwargs
):
super(ImageDiskReference, self).__init__(**kwargs)
self.id = id
self.lun = lun
[docs]class ImageListResult(msrest.serialization.Model):
"""The List Image operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of Images.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.Image]
:param next_link: The uri to fetch the next page of Images. Call ListNext() with this to fetch
the next page of Images.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Image]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["Image"],
next_link: Optional[str] = None,
**kwargs
):
super(ImageListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ImageOSDisk(msrest.serialization.Model):
"""Describes an Operating System disk.
All required parameters must be populated in order to send to Azure.
:param os_type: Required. This property allows you to specify the type of the OS that is
included in the disk if creating a VM from a custom image. :code:`<br>`:code:`<br>` Possible
values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Possible
values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param os_state: Required. The OS State. Possible values include: "Generalized", "Specialized".
:type os_state: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemStateTypes
:param snapshot: The snapshot.
:type snapshot: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param managed_disk: The managedDisk.
:type managed_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param blob_uri: The Virtual Hard Disk.
:type blob_uri: str
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param disk_size_gb: Specifies the size of empty data disks in gigabytes. This element can be
used to overwrite the name of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:type disk_size_gb: int
"""
_validation = {
'os_type': {'required': True},
'os_state': {'required': True},
}
_attribute_map = {
'os_type': {'key': 'osType', 'type': 'str'},
'os_state': {'key': 'osState', 'type': 'str'},
'snapshot': {'key': 'snapshot', 'type': 'SubResource'},
'managed_disk': {'key': 'managedDisk', 'type': 'SubResource'},
'blob_uri': {'key': 'blobUri', 'type': 'str'},
'caching': {'key': 'caching', 'type': 'str'},
'disk_size_gb': {'key': 'diskSizeGB', 'type': 'int'},
}
def __init__(
self,
*,
os_type: Union[str, "OperatingSystemTypes"],
os_state: Union[str, "OperatingSystemStateTypes"],
snapshot: Optional["SubResource"] = None,
managed_disk: Optional["SubResource"] = None,
blob_uri: Optional[str] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
**kwargs
):
super(ImageOSDisk, self).__init__(**kwargs)
self.os_type = os_type
self.os_state = os_state
self.snapshot = snapshot
self.managed_disk = managed_disk
self.blob_uri = blob_uri
self.caching = caching
self.disk_size_gb = disk_size_gb
[docs]class SubResource(msrest.serialization.Model):
"""SubResource.
:param id: Resource Id.
:type id: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
**kwargs
):
super(SubResource, self).__init__(**kwargs)
self.id = id
[docs]class ImageReference(SubResource):
"""Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
:param id: Resource Id.
:type id: str
:param publisher: The image publisher.
:type publisher: str
:param offer: Specifies the offer of the platform image or marketplace image used to create the
virtual machine.
:type offer: str
:param sku: The image SKU.
:type sku: str
:param version: Specifies the version of the platform image or marketplace image used to create
the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and
Build are decimal numbers. Specify 'latest' to use the latest version of an image available at
deploy time. Even if you use 'latest', the VM image will not automatically update after deploy
time even if a new version becomes available.
:type version: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'publisher': {'key': 'publisher', 'type': 'str'},
'offer': {'key': 'offer', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'str'},
'version': {'key': 'version', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
publisher: Optional[str] = None,
offer: Optional[str] = None,
sku: Optional[str] = None,
version: Optional[str] = None,
**kwargs
):
super(ImageReference, self).__init__(id=id, **kwargs)
self.publisher = publisher
self.offer = offer
self.sku = sku
self.version = version
[docs]class ImageStorageProfile(msrest.serialization.Model):
"""Describes a storage profile.
All required parameters must be populated in order to send to Azure.
:param os_disk: Required. Specifies information about the operating system disk used by the
virtual machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks
and VHDs for Azure virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-
machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:type os_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.ImageOSDisk
:param data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-
windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:type data_disks: list[~azure.mgmt.compute.v2016_04_30_preview.models.ImageDataDisk]
"""
_validation = {
'os_disk': {'required': True},
}
_attribute_map = {
'os_disk': {'key': 'osDisk', 'type': 'ImageOSDisk'},
'data_disks': {'key': 'dataDisks', 'type': '[ImageDataDisk]'},
}
def __init__(
self,
*,
os_disk: "ImageOSDisk",
data_disks: Optional[List["ImageDataDisk"]] = None,
**kwargs
):
super(ImageStorageProfile, self).__init__(**kwargs)
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class InnerError(msrest.serialization.Model):
"""Inner error details.
:param exceptiontype: The exception type.
:type exceptiontype: str
:param errordetail: The internal error message or exception dump.
:type errordetail: str
"""
_attribute_map = {
'exceptiontype': {'key': 'exceptiontype', 'type': 'str'},
'errordetail': {'key': 'errordetail', 'type': 'str'},
}
def __init__(
self,
*,
exceptiontype: Optional[str] = None,
errordetail: Optional[str] = None,
**kwargs
):
super(InnerError, self).__init__(**kwargs)
self.exceptiontype = exceptiontype
self.errordetail = errordetail
[docs]class InstanceViewStatus(msrest.serialization.Model):
"""Instance view status.
:param code: The status code.
:type code: str
:param level: The level code. Possible values include: "Info", "Warning", "Error".
:type level: str or ~azure.mgmt.compute.v2016_04_30_preview.models.StatusLevelTypes
:param display_status: The short localizable label for the status.
:type display_status: str
:param message: The detailed status message, including for alerts and error messages.
:type message: str
:param time: The time of the status.
:type time: ~datetime.datetime
"""
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'level': {'key': 'level', 'type': 'str'},
'display_status': {'key': 'displayStatus', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
'time': {'key': 'time', 'type': 'iso-8601'},
}
def __init__(
self,
*,
code: Optional[str] = None,
level: Optional[Union[str, "StatusLevelTypes"]] = None,
display_status: Optional[str] = None,
message: Optional[str] = None,
time: Optional[datetime.datetime] = None,
**kwargs
):
super(InstanceViewStatus, self).__init__(**kwargs)
self.code = code
self.level = level
self.display_status = display_status
self.message = message
self.time = time
[docs]class KeyVaultAndKeyReference(msrest.serialization.Model):
"""Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.
All required parameters must be populated in order to send to Azure.
:param source_vault: Required. Resource id of the KeyVault containing the key or secret.
:type source_vault: ~azure.mgmt.compute.v2016_04_30_preview.models.SourceVault
:param key_url: Required. Url pointing to a key or secret in KeyVault.
:type key_url: str
"""
_validation = {
'source_vault': {'required': True},
'key_url': {'required': True},
}
_attribute_map = {
'source_vault': {'key': 'sourceVault', 'type': 'SourceVault'},
'key_url': {'key': 'keyUrl', 'type': 'str'},
}
def __init__(
self,
*,
source_vault: "SourceVault",
key_url: str,
**kwargs
):
super(KeyVaultAndKeyReference, self).__init__(**kwargs)
self.source_vault = source_vault
self.key_url = key_url
[docs]class KeyVaultAndSecretReference(msrest.serialization.Model):
"""Key Vault Secret Url and vault id of the encryption key.
All required parameters must be populated in order to send to Azure.
:param source_vault: Required. Resource id of the KeyVault containing the key or secret.
:type source_vault: ~azure.mgmt.compute.v2016_04_30_preview.models.SourceVault
:param secret_url: Required. Url pointing to a key or secret in KeyVault.
:type secret_url: str
"""
_validation = {
'source_vault': {'required': True},
'secret_url': {'required': True},
}
_attribute_map = {
'source_vault': {'key': 'sourceVault', 'type': 'SourceVault'},
'secret_url': {'key': 'secretUrl', 'type': 'str'},
}
def __init__(
self,
*,
source_vault: "SourceVault",
secret_url: str,
**kwargs
):
super(KeyVaultAndSecretReference, self).__init__(**kwargs)
self.source_vault = source_vault
self.secret_url = secret_url
[docs]class KeyVaultKeyReference(msrest.serialization.Model):
"""Describes a reference to Key Vault Key.
All required parameters must be populated in order to send to Azure.
:param key_url: Required. The URL referencing a key encryption key in Key Vault.
:type key_url: str
:param source_vault: Required. The relative URL of the Key Vault containing the key.
:type source_vault: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
"""
_validation = {
'key_url': {'required': True},
'source_vault': {'required': True},
}
_attribute_map = {
'key_url': {'key': 'keyUrl', 'type': 'str'},
'source_vault': {'key': 'sourceVault', 'type': 'SubResource'},
}
def __init__(
self,
*,
key_url: str,
source_vault: "SubResource",
**kwargs
):
super(KeyVaultKeyReference, self).__init__(**kwargs)
self.key_url = key_url
self.source_vault = source_vault
[docs]class KeyVaultSecretReference(msrest.serialization.Model):
"""Describes a reference to Key Vault Secret.
All required parameters must be populated in order to send to Azure.
:param secret_url: Required. The URL referencing a secret in a Key Vault.
:type secret_url: str
:param source_vault: Required. The relative URL of the Key Vault containing the secret.
:type source_vault: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
"""
_validation = {
'secret_url': {'required': True},
'source_vault': {'required': True},
}
_attribute_map = {
'secret_url': {'key': 'secretUrl', 'type': 'str'},
'source_vault': {'key': 'sourceVault', 'type': 'SubResource'},
}
def __init__(
self,
*,
secret_url: str,
source_vault: "SubResource",
**kwargs
):
super(KeyVaultSecretReference, self).__init__(**kwargs)
self.secret_url = secret_url
self.source_vault = source_vault
[docs]class LinuxConfiguration(msrest.serialization.Model):
"""Specifies the Linux operating system settings on the virtual machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on Azure-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_ :code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for Non-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:param disable_password_authentication: Specifies whether password authentication should be
disabled.
:type disable_password_authentication: bool
:param ssh: Specifies the ssh key configuration for a Linux OS.
:type ssh: ~azure.mgmt.compute.v2016_04_30_preview.models.SshConfiguration
"""
_attribute_map = {
'disable_password_authentication': {'key': 'disablePasswordAuthentication', 'type': 'bool'},
'ssh': {'key': 'ssh', 'type': 'SshConfiguration'},
}
def __init__(
self,
*,
disable_password_authentication: Optional[bool] = None,
ssh: Optional["SshConfiguration"] = None,
**kwargs
):
super(LinuxConfiguration, self).__init__(**kwargs)
self.disable_password_authentication = disable_password_authentication
self.ssh = ssh
[docs]class ListUsagesResult(msrest.serialization.Model):
"""The List Usages operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of compute resource usages.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.Usage]
:param next_link: The URI to fetch the next page of compute resource usage information. Call
ListNext() with this to fetch the next page of compute resource usage information.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Usage]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["Usage"],
next_link: Optional[str] = None,
**kwargs
):
super(ListUsagesResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ManagedDiskParameters(SubResource):
"""The parameters of a managed disk.
:param id: Resource Id.
:type id: str
:param storage_account_type: Specifies the storage account type for the managed disk. Possible
values are: Standard_LRS or Premium_LRS. Possible values include: "Standard_LRS",
"Premium_LRS".
:type storage_account_type: str or
~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'storage_account_type': {'key': 'storageAccountType', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
storage_account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
**kwargs
):
super(ManagedDiskParameters, self).__init__(id=id, **kwargs)
self.storage_account_type = storage_account_type
[docs]class NetworkInterfaceReference(SubResource):
"""Describes a network interface reference.
:param id: Resource Id.
:type id: str
:param primary: Specifies the primary network interface in case the virtual machine has more
than 1 network interface.
:type primary: bool
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'primary': {'key': 'properties.primary', 'type': 'bool'},
}
def __init__(
self,
*,
id: Optional[str] = None,
primary: Optional[bool] = None,
**kwargs
):
super(NetworkInterfaceReference, self).__init__(id=id, **kwargs)
self.primary = primary
[docs]class NetworkProfile(msrest.serialization.Model):
"""Specifies the network interfaces of the virtual machine.
:param network_interfaces: Specifies the list of resource Ids for the network interfaces
associated with the virtual machine.
:type network_interfaces:
list[~azure.mgmt.compute.v2016_04_30_preview.models.NetworkInterfaceReference]
"""
_attribute_map = {
'network_interfaces': {'key': 'networkInterfaces', 'type': '[NetworkInterfaceReference]'},
}
def __init__(
self,
*,
network_interfaces: Optional[List["NetworkInterfaceReference"]] = None,
**kwargs
):
super(NetworkProfile, self).__init__(**kwargs)
self.network_interfaces = network_interfaces
[docs]class OperationStatusResponse(msrest.serialization.Model):
"""Operation status response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Operation ID.
:vartype name: str
:ivar status: Operation status.
:vartype status: str
:ivar start_time: Start time of the operation.
:vartype start_time: ~datetime.datetime
:ivar end_time: End time of the operation.
:vartype end_time: ~datetime.datetime
:ivar error: Api error.
:vartype error: ~azure.mgmt.compute.v2016_04_30_preview.models.ApiError
"""
_validation = {
'name': {'readonly': True},
'status': {'readonly': True},
'start_time': {'readonly': True},
'end_time': {'readonly': True},
'error': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'status': {'key': 'status', 'type': 'str'},
'start_time': {'key': 'startTime', 'type': 'iso-8601'},
'end_time': {'key': 'endTime', 'type': 'iso-8601'},
'error': {'key': 'error', 'type': 'ApiError'},
}
def __init__(
self,
**kwargs
):
super(OperationStatusResponse, self).__init__(**kwargs)
self.name = None
self.status = None
self.start_time = None
self.end_time = None
self.error = None
[docs]class OSDisk(msrest.serialization.Model):
"""Specifies information about the operating system disk used by the virtual machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs for Azure virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
All required parameters must be populated in order to send to Azure.
:param os_type: This property allows you to specify the type of the OS that is included in the
disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>` Possible
values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Possible
values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param encryption_settings: Specifies the encryption settings for the OS Disk.
:code:`<br>`:code:`<br>` Minimum api-version: 2015-06-15.
:type encryption_settings:
~azure.mgmt.compute.v2016_04_30_preview.models.DiskEncryptionSettings
:param name: The disk name.
:type name: str
:param vhd: The virtual hard disk.
:type vhd: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualHardDisk
:param image: The source user image virtual hard disk. The virtual hard disk will be copied
before being attached to the virtual machine. If SourceImage is provided, the destination
virtual hard drive must not exist.
:type image: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualHardDisk
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param create_option: Required. Specifies how the virtual machine should be
created.:code:`<br>`:code:`<br>` Possible values are::code:`<br>`:code:`<br>` **Attach** \u2013
This value is used when you are using a specialized disk to create the virtual
machine.:code:`<br>`:code:`<br>` **FromImage** \u2013 This value is used when you are using an
image to create the virtual machine. If you are using a platform image, you also use the
imageReference element described above. If you are using a marketplace image, you also use the
plan element previously described. Possible values include: "FromImage", "Empty", "Attach".
:type create_option: str or
~azure.mgmt.compute.v2016_04_30_preview.models.DiskCreateOptionTypes
:param disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:type disk_size_gb: int
:param managed_disk: The managed disk parameters.
:type managed_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.ManagedDiskParameters
"""
_validation = {
'create_option': {'required': True},
}
_attribute_map = {
'os_type': {'key': 'osType', 'type': 'str'},
'encryption_settings': {'key': 'encryptionSettings', 'type': 'DiskEncryptionSettings'},
'name': {'key': 'name', 'type': 'str'},
'vhd': {'key': 'vhd', 'type': 'VirtualHardDisk'},
'image': {'key': 'image', 'type': 'VirtualHardDisk'},
'caching': {'key': 'caching', 'type': 'str'},
'create_option': {'key': 'createOption', 'type': 'str'},
'disk_size_gb': {'key': 'diskSizeGB', 'type': 'int'},
'managed_disk': {'key': 'managedDisk', 'type': 'ManagedDiskParameters'},
}
def __init__(
self,
*,
create_option: Union[str, "DiskCreateOptionTypes"],
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
encryption_settings: Optional["DiskEncryptionSettings"] = None,
name: Optional[str] = None,
vhd: Optional["VirtualHardDisk"] = None,
image: Optional["VirtualHardDisk"] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["ManagedDiskParameters"] = None,
**kwargs
):
super(OSDisk, self).__init__(**kwargs)
self.os_type = os_type
self.encryption_settings = encryption_settings
self.name = name
self.vhd = vhd
self.image = image
self.caching = caching
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
[docs]class OSDiskImage(msrest.serialization.Model):
"""Contains the os disk image information.
All required parameters must be populated in order to send to Azure.
:param operating_system: Required. The operating system of the osDiskImage. Possible values
include: "Windows", "Linux".
:type operating_system: str or
~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
"""
_validation = {
'operating_system': {'required': True},
}
_attribute_map = {
'operating_system': {'key': 'operatingSystem', 'type': 'str'},
}
def __init__(
self,
*,
operating_system: Union[str, "OperatingSystemTypes"],
**kwargs
):
super(OSDiskImage, self).__init__(**kwargs)
self.operating_system = operating_system
[docs]class OSProfile(msrest.serialization.Model):
"""Specifies the operating system settings for the virtual machine.
:param computer_name: Specifies the host OS name of the virtual machine.
:code:`<br>`:code:`<br>` This name cannot be updated after the VM is created.
:code:`<br>`:code:`<br>` **Max-length (Windows):** 15 characters :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters. :code:`<br>`:code:`<br>` For naming conventions and
restrictions see `Azure infrastructure services implementation guidelines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-
subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-
conventions>`_.
:type computer_name: str
:param admin_username: Specifies the name of the administrator account.
:code:`<br>`:code:`<br>` **Windows-only restriction:** Cannot end in "."
:code:`<br>`:code:`<br>` **Disallowed values:** "administrator", "admin", "user", "user1",
"test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2",
"aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql",
"support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
:code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 20
characters :code:`<br>`:code:`<br>`:code:`<li>` For root access to the Linux VM, see `Using
root privileges on Linux virtual machines in Azure <https://docs.microsoft.com/azure/virtual-
machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-
machines%2flinux%2ftoc.json>`_\ :code:`<br>`:code:`<li>` For a list of built-in system users on
Linux that should not be used in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-
usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:type admin_username: str
:param admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-
rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_ :code:`<br>`:code:`<br>` For
resetting root password, see `Manage users, SSH, and check or repair disks on Azure Linux VMs
using the VMAccess Extension <https://docs.microsoft.com/azure/virtual-machines/virtual-
machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-
machines%2flinux%2ftoc.json#reset-root-password>`_.
:type admin_password: str
:param custom_data: Specifies a base-64 encoded string of custom data. The base-64 encoded
string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum
length of the binary array is 65535 bytes. :code:`<br>`:code:`<br>` For using cloud-init for
your VM, see `Using cloud-init to customize a Linux VM during creation
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-
init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:type custom_data: str
:param windows_configuration: Specifies Windows operating system settings on the virtual
machine.
:type windows_configuration:
~azure.mgmt.compute.v2016_04_30_preview.models.WindowsConfiguration
:param linux_configuration: Specifies the Linux operating system settings on the virtual
machine. :code:`<br>`:code:`<br>`For a list of supported Linux distributions, see `Linux on
Azure-Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/virtual-
machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_
:code:`<br>`:code:`<br>` For running non-endorsed distributions, see `Information for Non-
Endorsed Distributions <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-
linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:type linux_configuration: ~azure.mgmt.compute.v2016_04_30_preview.models.LinuxConfiguration
:param secrets: Specifies set of certificates that should be installed onto the virtual
machine.
:type secrets: list[~azure.mgmt.compute.v2016_04_30_preview.models.VaultSecretGroup]
"""
_attribute_map = {
'computer_name': {'key': 'computerName', 'type': 'str'},
'admin_username': {'key': 'adminUsername', 'type': 'str'},
'admin_password': {'key': 'adminPassword', 'type': 'str'},
'custom_data': {'key': 'customData', 'type': 'str'},
'windows_configuration': {'key': 'windowsConfiguration', 'type': 'WindowsConfiguration'},
'linux_configuration': {'key': 'linuxConfiguration', 'type': 'LinuxConfiguration'},
'secrets': {'key': 'secrets', 'type': '[VaultSecretGroup]'},
}
def __init__(
self,
*,
computer_name: Optional[str] = None,
admin_username: Optional[str] = None,
admin_password: Optional[str] = None,
custom_data: Optional[str] = None,
windows_configuration: Optional["WindowsConfiguration"] = None,
linux_configuration: Optional["LinuxConfiguration"] = None,
secrets: Optional[List["VaultSecretGroup"]] = None,
**kwargs
):
super(OSProfile, self).__init__(**kwargs)
self.computer_name = computer_name
self.admin_username = admin_username
self.admin_password = admin_password
self.custom_data = custom_data
self.windows_configuration = windows_configuration
self.linux_configuration = linux_configuration
self.secrets = secrets
[docs]class Plan(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**.
:param name: The plan ID.
:type name: str
:param publisher: The publisher ID.
:type publisher: str
:param product: Specifies the product of the image from the marketplace. This is the same value
as Offer under the imageReference element.
:type product: str
:param promotion_code: The promotion code.
:type promotion_code: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'publisher': {'key': 'publisher', 'type': 'str'},
'product': {'key': 'product', 'type': 'str'},
'promotion_code': {'key': 'promotionCode', 'type': 'str'},
}
def __init__(
self,
*,
name: Optional[str] = None,
publisher: Optional[str] = None,
product: Optional[str] = None,
promotion_code: Optional[str] = None,
**kwargs
):
super(Plan, self).__init__(**kwargs)
self.name = name
self.publisher = publisher
self.product = product
self.promotion_code = promotion_code
[docs]class PurchasePlan(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.
:param publisher: Required. The publisher ID.
:type publisher: str
:param name: Required. The plan ID.
:type name: str
:param product: Required. Specifies the product of the image from the marketplace. This is the
same value as Offer under the imageReference element.
:type product: str
"""
_validation = {
'publisher': {'required': True},
'name': {'required': True},
'product': {'required': True},
}
_attribute_map = {
'publisher': {'key': 'publisher', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'product': {'key': 'product', 'type': 'str'},
}
def __init__(
self,
*,
publisher: str,
name: str,
product: str,
**kwargs
):
super(PurchasePlan, self).__init__(**kwargs)
self.publisher = publisher
self.name = name
self.product = product
[docs]class Sku(msrest.serialization.Model):
"""Describes a virtual machine scale set sku.
:param name: The sku name.
:type name: str
:param tier: Specifies the tier of virtual machines in a scale set.:code:`<br />`:code:`<br />`
Possible Values::code:`<br />`:code:`<br />` **Standard**\ :code:`<br />`:code:`<br />`
**Basic**.
:type tier: str
:param capacity: Specifies the number of virtual machines in the scale set.
:type capacity: long
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'tier': {'key': 'tier', 'type': 'str'},
'capacity': {'key': 'capacity', 'type': 'long'},
}
def __init__(
self,
*,
name: Optional[str] = None,
tier: Optional[str] = None,
capacity: Optional[int] = None,
**kwargs
):
super(Sku, self).__init__(**kwargs)
self.name = name
self.tier = tier
self.capacity = capacity
[docs]class Snapshot(Resource):
"""Snapshot resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param account_type: the storage account type of the disk. Possible values include:
"Standard_LRS", "Premium_LRS".
:type account_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
:ivar time_created: The time when the disk was created.
:vartype time_created: ~datetime.datetime
:param os_type: The Operating System type. Possible values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param creation_data: Disk source information. CreationData information cannot be changed after
the disk has been created.
:type creation_data: ~azure.mgmt.compute.v2016_04_30_preview.models.CreationData
:param disk_size_gb: 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.
:type disk_size_gb: int
:param encryption_settings: Encryption settings for disk or snapshot.
:type encryption_settings: ~azure.mgmt.compute.v2016_04_30_preview.models.EncryptionSettings
:ivar owner_id: A relative URI containing the VM id that has the disk attached.
:vartype owner_id: str
:ivar provisioning_state: The disk provisioning state.
:vartype provisioning_state: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'time_created': {'readonly': True},
'owner_id': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'time_created': {'key': 'properties.timeCreated', 'type': 'iso-8601'},
'os_type': {'key': 'properties.osType', 'type': 'str'},
'creation_data': {'key': 'properties.creationData', 'type': 'CreationData'},
'disk_size_gb': {'key': 'properties.diskSizeGB', 'type': 'int'},
'encryption_settings': {'key': 'properties.encryptionSettings', 'type': 'EncryptionSettings'},
'owner_id': {'key': 'properties.ownerId', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
creation_data: Optional["CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings: Optional["EncryptionSettings"] = None,
**kwargs
):
super(Snapshot, self).__init__(location=location, tags=tags, **kwargs)
self.account_type = account_type
self.time_created = None
self.os_type = os_type
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.encryption_settings = encryption_settings
self.owner_id = None
self.provisioning_state = None
[docs]class SnapshotList(msrest.serialization.Model):
"""The List Snapshots operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. A list of snapshots.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.Snapshot]
:param next_link: The uri to fetch the next page of snapshots. Call ListNext() with this to
fetch the next page of snapshots.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[Snapshot]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["Snapshot"],
next_link: Optional[str] = None,
**kwargs
):
super(SnapshotList, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class SnapshotUpdate(ResourceUpdate):
"""Snapshot update resource.
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param account_type: the storage account type of the disk. Possible values include:
"Standard_LRS", "Premium_LRS".
:type account_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
:param os_type: the Operating System type. Possible values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param creation_data: disk source information. CreationData information cannot be changed after
the disk has been created.
:type creation_data: ~azure.mgmt.compute.v2016_04_30_preview.models.CreationData
:param disk_size_gb: 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.
:type disk_size_gb: int
:param encryption_settings: Encryption settings for disk or snapshot.
:type encryption_settings: ~azure.mgmt.compute.v2016_04_30_preview.models.EncryptionSettings
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'os_type': {'key': 'properties.osType', 'type': 'str'},
'creation_data': {'key': 'properties.creationData', 'type': 'CreationData'},
'disk_size_gb': {'key': 'properties.diskSizeGB', 'type': 'int'},
'encryption_settings': {'key': 'properties.encryptionSettings', 'type': 'EncryptionSettings'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
creation_data: Optional["CreationData"] = None,
disk_size_gb: Optional[int] = None,
encryption_settings: Optional["EncryptionSettings"] = None,
**kwargs
):
super(SnapshotUpdate, self).__init__(tags=tags, **kwargs)
self.account_type = account_type
self.os_type = os_type
self.creation_data = creation_data
self.disk_size_gb = disk_size_gb
self.encryption_settings = encryption_settings
[docs]class SourceVault(msrest.serialization.Model):
"""The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}.
:param id: Resource Id.
:type id: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
*,
id: Optional[str] = None,
**kwargs
):
super(SourceVault, self).__init__(**kwargs)
self.id = id
[docs]class SshConfiguration(msrest.serialization.Model):
"""SSH configuration for Linux based VMs running on Azure.
:param public_keys: The list of SSH public keys used to authenticate with linux based VMs.
:type public_keys: list[~azure.mgmt.compute.v2016_04_30_preview.models.SshPublicKey]
"""
_attribute_map = {
'public_keys': {'key': 'publicKeys', 'type': '[SshPublicKey]'},
}
def __init__(
self,
*,
public_keys: Optional[List["SshPublicKey"]] = None,
**kwargs
):
super(SshConfiguration, self).__init__(**kwargs)
self.public_keys = public_keys
[docs]class SshPublicKey(msrest.serialization.Model):
"""Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
:param path: Specifies the full path on the created VM where ssh public key is stored. If the
file already exists, the specified key is appended to the file. Example:
/home/user/.ssh/authorized_keys.
:type path: str
:param key_data: SSH public key certificate used to authenticate with the VM through ssh. The
key needs to be at least 2048-bit and in ssh-rsa format. :code:`<br>`:code:`<br>` For creating
ssh keys, see `Create SSH keys on Linux and Mac for Linux VMs in Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-
keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:type key_data: str
"""
_attribute_map = {
'path': {'key': 'path', 'type': 'str'},
'key_data': {'key': 'keyData', 'type': 'str'},
}
def __init__(
self,
*,
path: Optional[str] = None,
key_data: Optional[str] = None,
**kwargs
):
super(SshPublicKey, self).__init__(**kwargs)
self.path = path
self.key_data = key_data
[docs]class StorageProfile(msrest.serialization.Model):
"""Specifies the storage settings for the virtual machine disks.
:param image_reference: Specifies information about the image to use. You can specify
information about platform images, marketplace images, or virtual machine images. This element
is required when you want to use a platform image, marketplace image, or virtual machine image,
but is not used in other creation operations.
:type image_reference: ~azure.mgmt.compute.v2016_04_30_preview.models.ImageReference
:param os_disk: Specifies information about the operating system disk used by the virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-
windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:type os_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.OSDisk
:param data_disks: Specifies the parameters that are used to add a data disk to a virtual
machine. :code:`<br>`:code:`<br>` For more information about disks, see `About disks and VHDs
for Azure virtual machines <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-
windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_.
:type data_disks: list[~azure.mgmt.compute.v2016_04_30_preview.models.DataDisk]
"""
_attribute_map = {
'image_reference': {'key': 'imageReference', 'type': 'ImageReference'},
'os_disk': {'key': 'osDisk', 'type': 'OSDisk'},
'data_disks': {'key': 'dataDisks', 'type': '[DataDisk]'},
}
def __init__(
self,
*,
image_reference: Optional["ImageReference"] = None,
os_disk: Optional["OSDisk"] = None,
data_disks: Optional[List["DataDisk"]] = None,
**kwargs
):
super(StorageProfile, self).__init__(**kwargs)
self.image_reference = image_reference
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class SubResourceReadOnly(msrest.serialization.Model):
"""SubResourceReadOnly.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
"""
_validation = {
'id': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(SubResourceReadOnly, self).__init__(**kwargs)
self.id = None
[docs]class UpdateResource(msrest.serialization.Model):
"""The Update Resource model definition.
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
super(UpdateResource, self).__init__(**kwargs)
self.tags = tags
[docs]class UpgradePolicy(msrest.serialization.Model):
"""Describes an upgrade policy - automatic or manual.
:param mode: Specifies the mode of an upgrade to virtual machines in the scale set.:code:`<br
/>`:code:`<br />` Possible values are::code:`<br />`:code:`<br />` **Manual** - You control
the application of updates to virtual machines in the scale set. You do this by using the
manualUpgrade action.:code:`<br />`:code:`<br />` **Automatic** - All virtual machines in the
scale set are automatically updated at the same time. Possible values include: "Automatic",
"Manual".
:type mode: str or ~azure.mgmt.compute.v2016_04_30_preview.models.UpgradeMode
"""
_attribute_map = {
'mode': {'key': 'mode', 'type': 'str'},
}
def __init__(
self,
*,
mode: Optional[Union[str, "UpgradeMode"]] = None,
**kwargs
):
super(UpgradePolicy, self).__init__(**kwargs)
self.mode = mode
[docs]class Usage(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.
:ivar unit: Required. An enum describing the unit of usage measurement. Default value: "Count".
:vartype unit: str
:param current_value: Required. The current usage of the resource.
:type current_value: int
:param limit: Required. The maximum permitted usage of the resource.
:type limit: long
:param name: Required. The name of the type of usage.
:type name: ~azure.mgmt.compute.v2016_04_30_preview.models.UsageName
"""
_validation = {
'unit': {'required': True, 'constant': True},
'current_value': {'required': True},
'limit': {'required': True},
'name': {'required': True},
}
_attribute_map = {
'unit': {'key': 'unit', 'type': 'str'},
'current_value': {'key': 'currentValue', 'type': 'int'},
'limit': {'key': 'limit', 'type': 'long'},
'name': {'key': 'name', 'type': 'UsageName'},
}
unit = "Count"
def __init__(
self,
*,
current_value: int,
limit: int,
name: "UsageName",
**kwargs
):
super(Usage, self).__init__(**kwargs)
self.current_value = current_value
self.limit = limit
self.name = name
[docs]class UsageName(msrest.serialization.Model):
"""The Usage Names.
:param value: The name of the resource.
:type value: str
:param localized_value: The localized name of the resource.
:type localized_value: str
"""
_attribute_map = {
'value': {'key': 'value', 'type': 'str'},
'localized_value': {'key': 'localizedValue', 'type': 'str'},
}
def __init__(
self,
*,
value: Optional[str] = None,
localized_value: Optional[str] = None,
**kwargs
):
super(UsageName, self).__init__(**kwargs)
self.value = value
self.localized_value = localized_value
[docs]class VaultCertificate(msrest.serialization.Model):
"""Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
:param certificate_url: This is the URL of a certificate that has been uploaded to Key Vault as
a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>` "data":":code:`<Base64-encoded-
certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>` "password":":code:`<pfx-file-
password>`":code:`<br>`}.
:type certificate_url: str
:param certificate_store: For Windows VMs, specifies the certificate store on the Virtual
Machine to which the certificate should be added. The specified certificate store is implicitly
in the LocalMachine account. :code:`<br>`:code:`<br>`For Linux VMs, the certificate file is
placed under the /var/lib/waagent directory, with the file name
:code:`<UppercaseThumbprint>`.crt for the X509 certificate file and
:code:`<UppercaseThumbprint>`.prv for private key. Both of these files are .pem formatted.
:type certificate_store: str
"""
_attribute_map = {
'certificate_url': {'key': 'certificateUrl', 'type': 'str'},
'certificate_store': {'key': 'certificateStore', 'type': 'str'},
}
def __init__(
self,
*,
certificate_url: Optional[str] = None,
certificate_store: Optional[str] = None,
**kwargs
):
super(VaultCertificate, self).__init__(**kwargs)
self.certificate_url = certificate_url
self.certificate_store = certificate_store
[docs]class VaultSecretGroup(msrest.serialization.Model):
"""Describes a set of certificates which are all in the same Key Vault.
:param source_vault: The relative URL of the Key Vault containing all of the certificates in
VaultCertificates.
:type source_vault: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:param vault_certificates: The list of key vault references in SourceVault which contain
certificates.
:type vault_certificates: list[~azure.mgmt.compute.v2016_04_30_preview.models.VaultCertificate]
"""
_attribute_map = {
'source_vault': {'key': 'sourceVault', 'type': 'SubResource'},
'vault_certificates': {'key': 'vaultCertificates', 'type': '[VaultCertificate]'},
}
def __init__(
self,
*,
source_vault: Optional["SubResource"] = None,
vault_certificates: Optional[List["VaultCertificate"]] = None,
**kwargs
):
super(VaultSecretGroup, self).__init__(**kwargs)
self.source_vault = source_vault
self.vault_certificates = vault_certificates
[docs]class VirtualHardDisk(msrest.serialization.Model):
"""Describes the uri of a disk.
:param uri: Specifies the virtual hard disk's uri.
:type uri: str
"""
_attribute_map = {
'uri': {'key': 'uri', 'type': 'str'},
}
def __init__(
self,
*,
uri: Optional[str] = None,
**kwargs
):
super(VirtualHardDisk, self).__init__(**kwargs)
self.uri = uri
[docs]class VirtualMachine(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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param 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**.
:type plan: ~azure.mgmt.compute.v2016_04_30_preview.models.Plan
:ivar resources: The virtual machine child extension resources.
:vartype resources:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtension]
:param identity: The identity of the virtual machine, if configured.
:type identity: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineIdentity
:param hardware_profile: Specifies the hardware settings for the virtual machine.
:type hardware_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.HardwareProfile
:param storage_profile: Specifies the storage settings for the virtual machine disks.
:type storage_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.StorageProfile
:param os_profile: Specifies the operating system settings for the virtual machine.
:type os_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.OSProfile
:param network_profile: Specifies the network interfaces of the virtual machine.
:type network_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.NetworkProfile
:param diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:type diagnostics_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.DiagnosticsProfile
:param availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-
availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_. :code:`<br>`:code:`<br>`
For more information on Azure planned maintenance, see `Planned maintenance for virtual
machines in Azure <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-
planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.
:type availability_set: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:ivar instance_view: The virtual machine instance view.
:vartype instance_view:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineInstanceView
:param license_type: Specifies that the image or disk that is being used was licensed on-
premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-
licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_ :code:`<br>`:code:`<br>`
Minimum api-version: 2015-06-15.
:type license_type: str
:ivar vm_id: Specifies the VM unique ID which is a 128-bits identifier that is encoded and
stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
:vartype vm_id: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'resources': {'readonly': True},
'provisioning_state': {'readonly': True},
'instance_view': {'readonly': True},
'vm_id': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'plan': {'key': 'plan', 'type': 'Plan'},
'resources': {'key': 'resources', 'type': '[VirtualMachineExtension]'},
'identity': {'key': 'identity', 'type': 'VirtualMachineIdentity'},
'hardware_profile': {'key': 'properties.hardwareProfile', 'type': 'HardwareProfile'},
'storage_profile': {'key': 'properties.storageProfile', 'type': 'StorageProfile'},
'os_profile': {'key': 'properties.osProfile', 'type': 'OSProfile'},
'network_profile': {'key': 'properties.networkProfile', 'type': 'NetworkProfile'},
'diagnostics_profile': {'key': 'properties.diagnosticsProfile', 'type': 'DiagnosticsProfile'},
'availability_set': {'key': 'properties.availabilitySet', 'type': 'SubResource'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'instance_view': {'key': 'properties.instanceView', 'type': 'VirtualMachineInstanceView'},
'license_type': {'key': 'properties.licenseType', 'type': 'str'},
'vm_id': {'key': 'properties.vmId', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
plan: Optional["Plan"] = None,
identity: Optional["VirtualMachineIdentity"] = 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
):
super(VirtualMachine, self).__init__(location=location, tags=tags, **kwargs)
self.plan = plan
self.resources = None
self.identity = identity
self.hardware_profile = hardware_profile
self.storage_profile = storage_profile
self.os_profile = os_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.availability_set = availability_set
self.provisioning_state = None
self.instance_view = None
self.license_type = license_type
self.vm_id = None
[docs]class VirtualMachineAgentInstanceView(msrest.serialization.Model):
"""The instance view of the VM Agent running on the virtual machine.
:param vm_agent_version: The VM Agent full version.
:type vm_agent_version: str
:param extension_handlers: The virtual machine extension handler instance view.
:type extension_handlers:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtensionHandlerInstanceView]
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
"""
_attribute_map = {
'vm_agent_version': {'key': 'vmAgentVersion', 'type': 'str'},
'extension_handlers': {'key': 'extensionHandlers', 'type': '[VirtualMachineExtensionHandlerInstanceView]'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
}
def __init__(
self,
*,
vm_agent_version: Optional[str] = None,
extension_handlers: Optional[List["VirtualMachineExtensionHandlerInstanceView"]] = None,
statuses: Optional[List["InstanceViewStatus"]] = None,
**kwargs
):
super(VirtualMachineAgentInstanceView, self).__init__(**kwargs)
self.vm_agent_version = vm_agent_version
self.extension_handlers = extension_handlers
self.statuses = statuses
[docs]class VirtualMachineCaptureParameters(msrest.serialization.Model):
"""Capture Virtual Machine parameters.
All required parameters must be populated in order to send to Azure.
:param vhd_prefix: Required. The captured virtual hard disk's name prefix.
:type vhd_prefix: str
:param destination_container_name: Required. The destination container name.
:type destination_container_name: str
:param overwrite_vhds: Required. Specifies whether to overwrite the destination virtual hard
disk, in case of conflict.
:type overwrite_vhds: bool
"""
_validation = {
'vhd_prefix': {'required': True},
'destination_container_name': {'required': True},
'overwrite_vhds': {'required': True},
}
_attribute_map = {
'vhd_prefix': {'key': 'vhdPrefix', 'type': 'str'},
'destination_container_name': {'key': 'destinationContainerName', 'type': 'str'},
'overwrite_vhds': {'key': 'overwriteVhds', 'type': 'bool'},
}
def __init__(
self,
*,
vhd_prefix: str,
destination_container_name: str,
overwrite_vhds: bool,
**kwargs
):
super(VirtualMachineCaptureParameters, self).__init__(**kwargs)
self.vhd_prefix = vhd_prefix
self.destination_container_name = destination_container_name
self.overwrite_vhds = overwrite_vhds
[docs]class VirtualMachineCaptureResult(SubResource):
"""Resource Id.
:param id: Resource Id.
:type id: str
:param output: Operation output data (raw JSON).
:type output: object
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'output': {'key': 'properties.output', 'type': 'object'},
}
def __init__(
self,
*,
id: Optional[str] = None,
output: Optional[object] = None,
**kwargs
):
super(VirtualMachineCaptureResult, self).__init__(id=id, **kwargs)
self.output = output
[docs]class VirtualMachineExtension(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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:type force_update_tag: str
:param publisher: The name of the extension handler publisher.
:type publisher: str
:param type_properties_type: Specifies the type of the extension; an example is
"CustomScriptExtension".
:type type_properties_type: str
:param type_handler_version: Specifies the version of the script handler.
:type type_handler_version: str
:param auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:type auto_upgrade_minor_version: bool
:param settings: Json formatted public settings for the extension.
:type settings: object
:param protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:type protected_settings: object
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:param instance_view: The virtual machine extension instance view.
:type instance_view:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtensionInstanceView
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'force_update_tag': {'key': 'properties.forceUpdateTag', 'type': 'str'},
'publisher': {'key': 'properties.publisher', 'type': 'str'},
'type_properties_type': {'key': 'properties.type', 'type': 'str'},
'type_handler_version': {'key': 'properties.typeHandlerVersion', 'type': 'str'},
'auto_upgrade_minor_version': {'key': 'properties.autoUpgradeMinorVersion', 'type': 'bool'},
'settings': {'key': 'properties.settings', 'type': 'object'},
'protected_settings': {'key': 'properties.protectedSettings', 'type': 'object'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'instance_view': {'key': 'properties.instanceView', 'type': 'VirtualMachineExtensionInstanceView'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
force_update_tag: Optional[str] = None,
publisher: Optional[str] = None,
type_properties_type: Optional[str] = None,
type_handler_version: Optional[str] = None,
auto_upgrade_minor_version: Optional[bool] = None,
settings: Optional[object] = None,
protected_settings: Optional[object] = None,
instance_view: Optional["VirtualMachineExtensionInstanceView"] = None,
**kwargs
):
super(VirtualMachineExtension, self).__init__(location=location, tags=tags, **kwargs)
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type_properties_type = type_properties_type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
self.provisioning_state = None
self.instance_view = instance_view
[docs]class VirtualMachineExtensionHandlerInstanceView(msrest.serialization.Model):
"""The instance view of a virtual machine extension handler.
:param type: Specifies the type of the extension; an example is "CustomScriptExtension".
:type type: str
:param type_handler_version: Specifies the version of the script handler.
:type type_handler_version: str
:param status: The extension handler status.
:type status: ~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus
"""
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'type_handler_version': {'key': 'typeHandlerVersion', 'type': 'str'},
'status': {'key': 'status', 'type': 'InstanceViewStatus'},
}
def __init__(
self,
*,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
status: Optional["InstanceViewStatus"] = None,
**kwargs
):
super(VirtualMachineExtensionHandlerInstanceView, self).__init__(**kwargs)
self.type = type
self.type_handler_version = type_handler_version
self.status = status
[docs]class VirtualMachineExtensionImage(Resource):
"""Describes a Virtual Machine Extension Image.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param operating_system: The operating system this extension supports.
:type operating_system: str
:param compute_role: The type of role (IaaS or PaaS) this extension supports.
:type compute_role: str
:param handler_schema: The schema defined by publisher, where extension consumers should
provide settings in a matching schema.
:type handler_schema: str
:param vm_scale_set_enabled: Whether the extension can be used on xRP VMScaleSets. By default
existing extensions are usable on scalesets, but there might be cases where a publisher wants
to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
:type vm_scale_set_enabled: bool
:param supports_multiple_extensions: Whether the handler can support multiple extensions.
:type supports_multiple_extensions: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'operating_system': {'key': 'properties.operatingSystem', 'type': 'str'},
'compute_role': {'key': 'properties.computeRole', 'type': 'str'},
'handler_schema': {'key': 'properties.handlerSchema', 'type': 'str'},
'vm_scale_set_enabled': {'key': 'properties.vmScaleSetEnabled', 'type': 'bool'},
'supports_multiple_extensions': {'key': 'properties.supportsMultipleExtensions', 'type': 'bool'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
operating_system: Optional[str] = None,
compute_role: Optional[str] = None,
handler_schema: Optional[str] = None,
vm_scale_set_enabled: Optional[bool] = None,
supports_multiple_extensions: Optional[bool] = None,
**kwargs
):
super(VirtualMachineExtensionImage, self).__init__(location=location, tags=tags, **kwargs)
self.operating_system = operating_system
self.compute_role = compute_role
self.handler_schema = handler_schema
self.vm_scale_set_enabled = vm_scale_set_enabled
self.supports_multiple_extensions = supports_multiple_extensions
[docs]class VirtualMachineExtensionInstanceView(msrest.serialization.Model):
"""The instance view of a virtual machine extension.
:param name: The virtual machine extension name.
:type name: str
:param type: Specifies the type of the extension; an example is "CustomScriptExtension".
:type type: str
:param type_handler_version: Specifies the version of the script handler.
:type type_handler_version: str
:param substatuses: The resource status information.
:type substatuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'type_handler_version': {'key': 'typeHandlerVersion', 'type': 'str'},
'substatuses': {'key': 'substatuses', 'type': '[InstanceViewStatus]'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
}
def __init__(
self,
*,
name: Optional[str] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
substatuses: Optional[List["InstanceViewStatus"]] = None,
statuses: Optional[List["InstanceViewStatus"]] = None,
**kwargs
):
super(VirtualMachineExtensionInstanceView, self).__init__(**kwargs)
self.name = name
self.type = type
self.type_handler_version = type_handler_version
self.substatuses = substatuses
self.statuses = statuses
[docs]class VirtualMachineExtensionsListResult(msrest.serialization.Model):
"""The List Extension operation response.
:param value: The list of extensions.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtension]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineExtension]'},
}
def __init__(
self,
*,
value: Optional[List["VirtualMachineExtension"]] = None,
**kwargs
):
super(VirtualMachineExtensionsListResult, self).__init__(**kwargs)
self.value = value
[docs]class VirtualMachineExtensionUpdate(UpdateResource):
"""Describes a Virtual Machine Extension.
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param force_update_tag: How the extension handler should be forced to update even if the
extension configuration has not changed.
:type force_update_tag: str
:param publisher: The name of the extension handler publisher.
:type publisher: str
:param type: Specifies the type of the extension; an example is "CustomScriptExtension".
:type type: str
:param type_handler_version: Specifies the version of the script handler.
:type type_handler_version: str
:param auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:type auto_upgrade_minor_version: bool
:param settings: Json formatted public settings for the extension.
:type settings: object
:param protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:type protected_settings: object
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
'force_update_tag': {'key': 'properties.forceUpdateTag', 'type': 'str'},
'publisher': {'key': 'properties.publisher', 'type': 'str'},
'type': {'key': 'properties.type', 'type': 'str'},
'type_handler_version': {'key': 'properties.typeHandlerVersion', 'type': 'str'},
'auto_upgrade_minor_version': {'key': 'properties.autoUpgradeMinorVersion', 'type': 'bool'},
'settings': {'key': 'properties.settings', 'type': 'object'},
'protected_settings': {'key': 'properties.protectedSettings', 'type': 'object'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
force_update_tag: Optional[str] = None,
publisher: Optional[str] = None,
type: Optional[str] = None,
type_handler_version: Optional[str] = None,
auto_upgrade_minor_version: Optional[bool] = None,
settings: Optional[object] = None,
protected_settings: Optional[object] = None,
**kwargs
):
super(VirtualMachineExtensionUpdate, self).__init__(tags=tags, **kwargs)
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type = type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
[docs]class VirtualMachineIdentity(msrest.serialization.Model):
"""Identity for the virtual machine.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of virtual machine identity.
:vartype principal_id: str
:ivar tenant_id: The tenant id associated with the virtual machine.
:vartype tenant_id: str
:ivar type: The type of identity used for the virtual machine. Currently, the only supported
type is 'SystemAssigned', which implicitly creates an identity. Default value:
"SystemAssigned".
:vartype type: str
"""
_validation = {
'principal_id': {'readonly': True},
'tenant_id': {'readonly': True},
'type': {'constant': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
type = "SystemAssigned"
def __init__(
self,
**kwargs
):
super(VirtualMachineIdentity, self).__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
[docs]class VirtualMachineImageResource(SubResource):
"""Virtual machine image resource information.
All required parameters must be populated in order to send to Azure.
:param id: Resource Id.
:type id: str
:param name: Required. The name of the resource.
:type name: str
:param location: Required. The supported Azure location of the resource.
:type location: str
:param tags: 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
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:type tags: dict[str, str]
"""
_validation = {
'name': {'required': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(
self,
*,
name: str,
location: str,
id: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
super(VirtualMachineImageResource, self).__init__(id=id, **kwargs)
self.name = name
self.location = location
self.tags = tags
[docs]class VirtualMachineImage(VirtualMachineImageResource):
"""Describes a Virtual Machine Image.
All required parameters must be populated in order to send to Azure.
:param id: Resource Id.
:type id: str
:param name: Required. The name of the resource.
:type name: str
:param location: Required. The supported Azure location of the resource.
:type location: str
:param tags: 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
<https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md>`_.
:type tags: dict[str, str]
:param plan: Used for establishing the purchase context of any 3rd Party artifact through
MarketPlace.
:type plan: ~azure.mgmt.compute.v2016_04_30_preview.models.PurchasePlan
:param os_disk_image: Contains the os disk image information.
:type os_disk_image: ~azure.mgmt.compute.v2016_04_30_preview.models.OSDiskImage
:param data_disk_images:
:type data_disk_images: list[~azure.mgmt.compute.v2016_04_30_preview.models.DataDiskImage]
"""
_validation = {
'name': {'required': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'plan': {'key': 'properties.plan', 'type': 'PurchasePlan'},
'os_disk_image': {'key': 'properties.osDiskImage', 'type': 'OSDiskImage'},
'data_disk_images': {'key': 'properties.dataDiskImages', 'type': '[DataDiskImage]'},
}
def __init__(
self,
*,
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
):
super(VirtualMachineImage, self).__init__(id=id, name=name, location=location, tags=tags, **kwargs)
self.plan = plan
self.os_disk_image = os_disk_image
self.data_disk_images = data_disk_images
[docs]class VirtualMachineInstanceView(msrest.serialization.Model):
"""The instance view of a virtual machine.
:param platform_update_domain: Specifies the update domain of the virtual machine.
:type platform_update_domain: int
:param platform_fault_domain: Specifies the fault domain of the virtual machine.
:type platform_fault_domain: int
:param rdp_thumb_print: The Remote desktop certificate thumbprint.
:type rdp_thumb_print: str
:param vm_agent: The VM Agent running on the virtual machine.
:type vm_agent: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineAgentInstanceView
:param disks: The virtual machine disk information.
:type disks: list[~azure.mgmt.compute.v2016_04_30_preview.models.DiskInstanceView]
:param extensions: The extensions information.
:type extensions:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtensionInstanceView]
:param boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:type boot_diagnostics:
~azure.mgmt.compute.v2016_04_30_preview.models.BootDiagnosticsInstanceView
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
"""
_attribute_map = {
'platform_update_domain': {'key': 'platformUpdateDomain', 'type': 'int'},
'platform_fault_domain': {'key': 'platformFaultDomain', 'type': 'int'},
'rdp_thumb_print': {'key': 'rdpThumbPrint', 'type': 'str'},
'vm_agent': {'key': 'vmAgent', 'type': 'VirtualMachineAgentInstanceView'},
'disks': {'key': 'disks', 'type': '[DiskInstanceView]'},
'extensions': {'key': 'extensions', 'type': '[VirtualMachineExtensionInstanceView]'},
'boot_diagnostics': {'key': 'bootDiagnostics', 'type': 'BootDiagnosticsInstanceView'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
}
def __init__(
self,
*,
platform_update_domain: Optional[int] = None,
platform_fault_domain: Optional[int] = None,
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
):
super(VirtualMachineInstanceView, self).__init__(**kwargs)
self.platform_update_domain = platform_update_domain
self.platform_fault_domain = platform_fault_domain
self.rdp_thumb_print = rdp_thumb_print
self.vm_agent = vm_agent
self.disks = disks
self.extensions = extensions
self.boot_diagnostics = boot_diagnostics
self.statuses = statuses
[docs]class VirtualMachineListResult(msrest.serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of virtual machines.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachine]
:param next_link: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch
the next page of Virtual Machines.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachine]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["VirtualMachine"],
next_link: Optional[str] = None,
**kwargs
):
super(VirtualMachineListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSet(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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:param sku: The virtual machine scale set sku.
:type sku: ~azure.mgmt.compute.v2016_04_30_preview.models.Sku
:param 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**.
:type plan: ~azure.mgmt.compute.v2016_04_30_preview.models.Plan
:param identity: The identity of the virtual machine scale set, if configured.
:type identity: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetIdentity
:param upgrade_policy: The upgrade policy.
:type upgrade_policy: ~azure.mgmt.compute.v2016_04_30_preview.models.UpgradePolicy
:param virtual_machine_profile: The virtual machine profile.
:type virtual_machine_profile:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMProfile
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:param over_provision: Specifies whether the Virtual Machine Scale Set should be
overprovisioned.
:type over_provision: bool
:param single_placement_group: When true this limits the scale set to a single placement group,
of max size 100 virtual machines.
:type single_placement_group: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'sku': {'key': 'sku', 'type': 'Sku'},
'plan': {'key': 'plan', 'type': 'Plan'},
'identity': {'key': 'identity', 'type': 'VirtualMachineScaleSetIdentity'},
'upgrade_policy': {'key': 'properties.upgradePolicy', 'type': 'UpgradePolicy'},
'virtual_machine_profile': {'key': 'properties.virtualMachineProfile', 'type': 'VirtualMachineScaleSetVMProfile'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'over_provision': {'key': 'properties.overProvision', 'type': 'bool'},
'single_placement_group': {'key': 'properties.singlePlacementGroup', 'type': 'bool'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["Sku"] = None,
plan: Optional["Plan"] = None,
identity: Optional["VirtualMachineScaleSetIdentity"] = None,
upgrade_policy: Optional["UpgradePolicy"] = None,
virtual_machine_profile: Optional["VirtualMachineScaleSetVMProfile"] = None,
over_provision: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
**kwargs
):
super(VirtualMachineScaleSet, self).__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.plan = plan
self.identity = identity
self.upgrade_policy = upgrade_policy
self.virtual_machine_profile = virtual_machine_profile
self.provisioning_state = None
self.over_provision = over_provision
self.single_placement_group = single_placement_group
[docs]class VirtualMachineScaleSetDataDisk(msrest.serialization.Model):
"""Describes a virtual machine scale set data disk.
All required parameters must be populated in order to send to Azure.
:param name: The disk name.
:type name: str
:param lun: 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.
:type lun: int
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param create_option: Required. The create option. Possible values include: "FromImage",
"Empty", "Attach".
:type create_option: str or
~azure.mgmt.compute.v2016_04_30_preview.models.DiskCreateOptionTypes
:param disk_size_gb: Specifies the size of an empty data disk in gigabytes. This element can be
used to overwrite the size of the disk in a virtual machine image. :code:`<br>`:code:`<br>`
This value cannot be larger than 1023 GB.
:type disk_size_gb: int
:param managed_disk: The managed disk parameters.
:type managed_disk:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetManagedDiskParameters
"""
_validation = {
'lun': {'required': True},
'create_option': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'lun': {'key': 'lun', 'type': 'int'},
'caching': {'key': 'caching', 'type': 'str'},
'create_option': {'key': 'createOption', 'type': 'str'},
'disk_size_gb': {'key': 'diskSizeGB', 'type': 'int'},
'managed_disk': {'key': 'managedDisk', 'type': 'VirtualMachineScaleSetManagedDiskParameters'},
}
def __init__(
self,
*,
lun: int,
create_option: Union[str, "DiskCreateOptionTypes"],
name: Optional[str] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
disk_size_gb: Optional[int] = None,
managed_disk: Optional["VirtualMachineScaleSetManagedDiskParameters"] = None,
**kwargs
):
super(VirtualMachineScaleSetDataDisk, self).__init__(**kwargs)
self.name = name
self.lun = lun
self.caching = caching
self.create_option = create_option
self.disk_size_gb = disk_size_gb
self.managed_disk = managed_disk
[docs]class VirtualMachineScaleSetExtension(SubResourceReadOnly):
"""Describes a Virtual Machine Scale Set Extension.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:param name: The name of the extension.
:type name: str
:param publisher: The name of the extension handler publisher.
:type publisher: str
:param type: Specifies the type of the extension; an example is "CustomScriptExtension".
:type type: str
:param type_handler_version: Specifies the version of the script handler.
:type type_handler_version: str
:param auto_upgrade_minor_version: Indicates whether the extension should use a newer minor
version if one is available at deployment time. Once deployed, however, the extension will not
upgrade minor versions unless redeployed, even with this property set to true.
:type auto_upgrade_minor_version: bool
:param settings: Json formatted public settings for the extension.
:type settings: object
:param protected_settings: The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
:type protected_settings: object
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
"""
_validation = {
'id': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'publisher': {'key': 'properties.publisher', 'type': 'str'},
'type': {'key': 'properties.type', 'type': 'str'},
'type_handler_version': {'key': 'properties.typeHandlerVersion', 'type': 'str'},
'auto_upgrade_minor_version': {'key': 'properties.autoUpgradeMinorVersion', 'type': 'bool'},
'settings': {'key': 'properties.settings', 'type': 'object'},
'protected_settings': {'key': 'properties.protectedSettings', 'type': 'object'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(
self,
*,
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: Optional[object] = None,
protected_settings: Optional[object] = None,
**kwargs
):
super(VirtualMachineScaleSetExtension, self).__init__(**kwargs)
self.name = name
self.publisher = publisher
self.type = type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
self.provisioning_state = None
[docs]class VirtualMachineScaleSetExtensionProfile(msrest.serialization.Model):
"""Describes a virtual machine scale set extension profile.
:param extensions: The virtual machine scale set child extension resources.
:type extensions:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetExtension]
"""
_attribute_map = {
'extensions': {'key': 'extensions', 'type': '[VirtualMachineScaleSetExtension]'},
}
def __init__(
self,
*,
extensions: Optional[List["VirtualMachineScaleSetExtension"]] = None,
**kwargs
):
super(VirtualMachineScaleSetExtensionProfile, self).__init__(**kwargs)
self.extensions = extensions
[docs]class VirtualMachineScaleSetIdentity(msrest.serialization.Model):
"""Identity for the virtual machine scale set.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal id of virtual machine scale set identity.
:vartype principal_id: str
:ivar tenant_id: The tenant id associated with the virtual machine scale set.
:vartype tenant_id: str
:ivar type: The type of identity used for the virtual machine scale set. Currently, the only
supported type is 'SystemAssigned', which implicitly creates an identity. Default value:
"SystemAssigned".
:vartype type: str
"""
_validation = {
'principal_id': {'readonly': True},
'tenant_id': {'readonly': True},
'type': {'constant': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
type = "SystemAssigned"
def __init__(
self,
**kwargs
):
super(VirtualMachineScaleSetIdentity, self).__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
[docs]class VirtualMachineScaleSetInstanceView(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.
:ivar virtual_machine: The instance view status summary for the virtual machine scale set.
:vartype virtual_machine:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetInstanceViewStatusesSummary
:ivar extensions: The extensions information.
:vartype extensions:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMExtensionsSummary]
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
"""
_validation = {
'virtual_machine': {'readonly': True},
'extensions': {'readonly': True},
}
_attribute_map = {
'virtual_machine': {'key': 'virtualMachine', 'type': 'VirtualMachineScaleSetInstanceViewStatusesSummary'},
'extensions': {'key': 'extensions', 'type': '[VirtualMachineScaleSetVMExtensionsSummary]'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
}
def __init__(
self,
*,
statuses: Optional[List["InstanceViewStatus"]] = None,
**kwargs
):
super(VirtualMachineScaleSetInstanceView, self).__init__(**kwargs)
self.virtual_machine = None
self.extensions = None
self.statuses = statuses
[docs]class VirtualMachineScaleSetInstanceViewStatusesSummary(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.
:ivar statuses_summary: The extensions information.
:vartype statuses_summary:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineStatusCodeCount]
"""
_validation = {
'statuses_summary': {'readonly': True},
}
_attribute_map = {
'statuses_summary': {'key': 'statusesSummary', 'type': '[VirtualMachineStatusCodeCount]'},
}
def __init__(
self,
**kwargs
):
super(VirtualMachineScaleSetInstanceViewStatusesSummary, self).__init__(**kwargs)
self.statuses_summary = None
[docs]class VirtualMachineScaleSetIPConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's IP configuration.
All required parameters must be populated in order to send to Azure.
:param id: Resource Id.
:type id: str
:param name: Required. The IP configuration name.
:type name: str
:param subnet: The subnet.
:type subnet: ~azure.mgmt.compute.v2016_04_30_preview.models.ApiEntityReference
:param application_gateway_backend_address_pools: The application gateway backend address
pools.
:type application_gateway_backend_address_pools:
list[~azure.mgmt.compute.v2016_04_30_preview.models.SubResource]
:param load_balancer_backend_address_pools: The load balancer backend address pools.
:type load_balancer_backend_address_pools:
list[~azure.mgmt.compute.v2016_04_30_preview.models.SubResource]
:param load_balancer_inbound_nat_pools: The load balancer inbound nat pools.
:type load_balancer_inbound_nat_pools:
list[~azure.mgmt.compute.v2016_04_30_preview.models.SubResource]
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'subnet': {'key': 'properties.subnet', 'type': 'ApiEntityReference'},
'application_gateway_backend_address_pools': {'key': 'properties.applicationGatewayBackendAddressPools', 'type': '[SubResource]'},
'load_balancer_backend_address_pools': {'key': 'properties.loadBalancerBackendAddressPools', 'type': '[SubResource]'},
'load_balancer_inbound_nat_pools': {'key': 'properties.loadBalancerInboundNatPools', 'type': '[SubResource]'},
}
def __init__(
self,
*,
name: str,
id: Optional[str] = None,
subnet: Optional["ApiEntityReference"] = None,
application_gateway_backend_address_pools: Optional[List["SubResource"]] = None,
load_balancer_backend_address_pools: Optional[List["SubResource"]] = None,
load_balancer_inbound_nat_pools: Optional[List["SubResource"]] = None,
**kwargs
):
super(VirtualMachineScaleSetIPConfiguration, self).__init__(id=id, **kwargs)
self.name = name
self.subnet = subnet
self.application_gateway_backend_address_pools = application_gateway_backend_address_pools
self.load_balancer_backend_address_pools = load_balancer_backend_address_pools
self.load_balancer_inbound_nat_pools = load_balancer_inbound_nat_pools
[docs]class VirtualMachineScaleSetListResult(msrest.serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of virtual machine scale sets.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet]
:param next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext()
with this to fetch the next page of VMSS.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineScaleSet]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["VirtualMachineScaleSet"],
next_link: Optional[str] = None,
**kwargs
):
super(VirtualMachineScaleSetListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetListSkusResult(msrest.serialization.Model):
"""The Virtual Machine Scale Set List Skus operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of skus available for the virtual machine scale set.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetSku]
:param next_link: The uri to fetch the next page of Virtual Machine Scale Set Skus. Call
ListNext() with this to fetch the next page of VMSS Skus.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineScaleSetSku]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["VirtualMachineScaleSetSku"],
next_link: Optional[str] = None,
**kwargs
):
super(VirtualMachineScaleSetListSkusResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetListWithLinkResult(msrest.serialization.Model):
"""The List Virtual Machine operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of virtual machine scale sets.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet]
:param next_link: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext()
with this to fetch the next page of Virtual Machine Scale Sets.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineScaleSet]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["VirtualMachineScaleSet"],
next_link: Optional[str] = None,
**kwargs
):
super(VirtualMachineScaleSetListWithLinkResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetManagedDiskParameters(msrest.serialization.Model):
"""Describes the parameters of a ScaleSet managed disk.
:param storage_account_type: Specifies the storage account type for the managed disk. Possible
values are: Standard_LRS or Premium_LRS. Possible values include: "Standard_LRS",
"Premium_LRS".
:type storage_account_type: str or
~azure.mgmt.compute.v2016_04_30_preview.models.StorageAccountTypes
"""
_attribute_map = {
'storage_account_type': {'key': 'storageAccountType', 'type': 'str'},
}
def __init__(
self,
*,
storage_account_type: Optional[Union[str, "StorageAccountTypes"]] = None,
**kwargs
):
super(VirtualMachineScaleSetManagedDiskParameters, self).__init__(**kwargs)
self.storage_account_type = storage_account_type
[docs]class VirtualMachineScaleSetNetworkConfiguration(SubResource):
"""Describes a virtual machine scale set network profile's network configurations.
All required parameters must be populated in order to send to Azure.
:param id: Resource Id.
:type id: str
:param name: Required. The network configuration name.
:type name: str
:param primary: Whether this is a primary NIC on a virtual machine.
:type primary: bool
:param ip_configurations: The virtual machine scale set IP Configuration.
:type ip_configurations:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetIPConfiguration]
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'primary': {'key': 'properties.primary', 'type': 'bool'},
'ip_configurations': {'key': 'properties.ipConfigurations', 'type': '[VirtualMachineScaleSetIPConfiguration]'},
}
def __init__(
self,
*,
name: str,
id: Optional[str] = None,
primary: Optional[bool] = None,
ip_configurations: Optional[List["VirtualMachineScaleSetIPConfiguration"]] = None,
**kwargs
):
super(VirtualMachineScaleSetNetworkConfiguration, self).__init__(id=id, **kwargs)
self.name = name
self.primary = primary
self.ip_configurations = ip_configurations
[docs]class VirtualMachineScaleSetNetworkProfile(msrest.serialization.Model):
"""Describes a virtual machine scale set network profile.
:param network_interface_configurations: The list of network configurations.
:type network_interface_configurations:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetNetworkConfiguration]
"""
_attribute_map = {
'network_interface_configurations': {'key': 'networkInterfaceConfigurations', 'type': '[VirtualMachineScaleSetNetworkConfiguration]'},
}
def __init__(
self,
*,
network_interface_configurations: Optional[List["VirtualMachineScaleSetNetworkConfiguration"]] = None,
**kwargs
):
super(VirtualMachineScaleSetNetworkProfile, self).__init__(**kwargs)
self.network_interface_configurations = network_interface_configurations
[docs]class VirtualMachineScaleSetOSDisk(msrest.serialization.Model):
"""Describes a virtual machine scale set operating system disk.
All required parameters must be populated in order to send to Azure.
:param name: The disk name.
:type name: str
:param caching: Specifies the caching requirements. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`:code:`<br>` **None** :code:`<br>`:code:`<br>` **ReadOnly**
:code:`<br>`:code:`<br>` **ReadWrite** :code:`<br>`:code:`<br>` Default: **None for Standard
storage. ReadOnly for Premium storage**. Possible values include: "None", "ReadOnly",
"ReadWrite".
:type caching: str or ~azure.mgmt.compute.v2016_04_30_preview.models.CachingTypes
:param create_option: Required. Specifies how the virtual machines in the scale set should be
created.:code:`<br>`:code:`<br>` The only allowed value is: **FromImage** \u2013 This value is
used when you are using an image to create the virtual machine. If you are using a platform
image, you also use the imageReference element described above. If you are using a marketplace
image, you also use the plan element previously described. Possible values include:
"FromImage", "Empty", "Attach".
:type create_option: str or
~azure.mgmt.compute.v2016_04_30_preview.models.DiskCreateOptionTypes
:param os_type: This property allows you to specify the type of the OS that is included in the
disk if creating a VM from user-image or a specialized VHD. :code:`<br>`:code:`<br>` Possible
values are: :code:`<br>`:code:`<br>` **Windows** :code:`<br>`:code:`<br>` **Linux**. Possible
values include: "Windows", "Linux".
:type os_type: str or ~azure.mgmt.compute.v2016_04_30_preview.models.OperatingSystemTypes
:param image: The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before
using it to attach to the Virtual Machine. If SourceImage is provided, the destination
VirtualHardDisk should not exist.
:type image: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualHardDisk
:param vhd_containers: The list of virtual hard disk container uris.
:type vhd_containers: list[str]
:param managed_disk: The managed disk parameters.
:type managed_disk:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetManagedDiskParameters
"""
_validation = {
'create_option': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'caching': {'key': 'caching', 'type': 'str'},
'create_option': {'key': 'createOption', 'type': 'str'},
'os_type': {'key': 'osType', 'type': 'str'},
'image': {'key': 'image', 'type': 'VirtualHardDisk'},
'vhd_containers': {'key': 'vhdContainers', 'type': '[str]'},
'managed_disk': {'key': 'managedDisk', 'type': 'VirtualMachineScaleSetManagedDiskParameters'},
}
def __init__(
self,
*,
create_option: Union[str, "DiskCreateOptionTypes"],
name: Optional[str] = None,
caching: Optional[Union[str, "CachingTypes"]] = None,
os_type: Optional[Union[str, "OperatingSystemTypes"]] = None,
image: Optional["VirtualHardDisk"] = None,
vhd_containers: Optional[List[str]] = None,
managed_disk: Optional["VirtualMachineScaleSetManagedDiskParameters"] = None,
**kwargs
):
super(VirtualMachineScaleSetOSDisk, self).__init__(**kwargs)
self.name = name
self.caching = caching
self.create_option = create_option
self.os_type = os_type
self.image = image
self.vhd_containers = vhd_containers
self.managed_disk = managed_disk
[docs]class VirtualMachineScaleSetOSProfile(msrest.serialization.Model):
"""Describes a virtual machine scale set OS profile.
:param computer_name_prefix: Specifies the computer name prefix for all of the virtual machines
in the scale set. Computer name prefixes must be 1 to 15 characters long.
:type computer_name_prefix: str
:param admin_username: Specifies the name of the administrator account.
:code:`<br>`:code:`<br>` **Windows-only restriction:** Cannot end in "."
:code:`<br>`:code:`<br>` **Disallowed values:** "administrator", "admin", "user", "user1",
"test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2",
"aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql",
"support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
:code:`<br>`:code:`<br>` **Minimum-length (Linux):** 1 character :code:`<br>`:code:`<br>`
**Max-length (Linux):** 64 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 20
characters :code:`<br>`:code:`<br>`:code:`<li>` For root access to the Linux VM, see `Using
root privileges on Linux virtual machines in Azure <https://docs.microsoft.com/azure/virtual-
machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-
machines%2flinux%2ftoc.json>`_\ :code:`<br>`:code:`<li>` For a list of built-in system users on
Linux that should not be used in this field, see `Selecting User Names for Linux on Azure
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-
usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json>`_.
:type admin_username: str
:param admin_password: Specifies the password of the administrator account.
:code:`<br>`:code:`<br>` **Minimum-length (Windows):** 8 characters :code:`<br>`:code:`<br>`
**Minimum-length (Linux):** 6 characters :code:`<br>`:code:`<br>` **Max-length (Windows):** 123
characters :code:`<br>`:code:`<br>` **Max-length (Linux):** 72 characters
:code:`<br>`:code:`<br>` **Complexity requirements:** 3 out of 4 conditions below need to be
fulfilled :code:`<br>` Has lower characters :code:`<br>`Has upper characters :code:`<br>` Has a
digit :code:`<br>` Has a special character (Regex match [\W_]) :code:`<br>`:code:`<br>`
**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word",
"pass@word1", "Password!", "Password1", "Password22", "iloveyou!" :code:`<br>`:code:`<br>` For
resetting the password, see `How to reset the Remote Desktop service or its login password in a
Windows VM <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-
rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_ :code:`<br>`:code:`<br>` For
resetting root password, see `Manage users, SSH, and check or repair disks on Azure Linux VMs
using the VMAccess Extension <https://docs.microsoft.com/azure/virtual-machines/virtual-
machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-
machines%2flinux%2ftoc.json#reset-root-password>`_.
:type admin_password: str
:param custom_data: A base-64 encoded string of custom data.
:type custom_data: str
:param windows_configuration: The Windows Configuration of the OS profile.
:type windows_configuration:
~azure.mgmt.compute.v2016_04_30_preview.models.WindowsConfiguration
:param linux_configuration: The Linux Configuration of the OS profile.
:type linux_configuration: ~azure.mgmt.compute.v2016_04_30_preview.models.LinuxConfiguration
:param secrets: The List of certificates for addition to the VM.
:type secrets: list[~azure.mgmt.compute.v2016_04_30_preview.models.VaultSecretGroup]
"""
_attribute_map = {
'computer_name_prefix': {'key': 'computerNamePrefix', 'type': 'str'},
'admin_username': {'key': 'adminUsername', 'type': 'str'},
'admin_password': {'key': 'adminPassword', 'type': 'str'},
'custom_data': {'key': 'customData', 'type': 'str'},
'windows_configuration': {'key': 'windowsConfiguration', 'type': 'WindowsConfiguration'},
'linux_configuration': {'key': 'linuxConfiguration', 'type': 'LinuxConfiguration'},
'secrets': {'key': 'secrets', 'type': '[VaultSecretGroup]'},
}
def __init__(
self,
*,
computer_name_prefix: Optional[str] = None,
admin_username: Optional[str] = None,
admin_password: Optional[str] = None,
custom_data: Optional[str] = None,
windows_configuration: Optional["WindowsConfiguration"] = None,
linux_configuration: Optional["LinuxConfiguration"] = None,
secrets: Optional[List["VaultSecretGroup"]] = None,
**kwargs
):
super(VirtualMachineScaleSetOSProfile, self).__init__(**kwargs)
self.computer_name_prefix = computer_name_prefix
self.admin_username = admin_username
self.admin_password = admin_password
self.custom_data = custom_data
self.windows_configuration = windows_configuration
self.linux_configuration = linux_configuration
self.secrets = secrets
[docs]class VirtualMachineScaleSetSku(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.
:ivar resource_type: The type of resource the sku applies to.
:vartype resource_type: str
:ivar sku: The Sku.
:vartype sku: ~azure.mgmt.compute.v2016_04_30_preview.models.Sku
:ivar capacity: Specifies the number of virtual machines in the scale set.
:vartype capacity:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetSkuCapacity
"""
_validation = {
'resource_type': {'readonly': True},
'sku': {'readonly': True},
'capacity': {'readonly': True},
}
_attribute_map = {
'resource_type': {'key': 'resourceType', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'Sku'},
'capacity': {'key': 'capacity', 'type': 'VirtualMachineScaleSetSkuCapacity'},
}
def __init__(
self,
**kwargs
):
super(VirtualMachineScaleSetSku, self).__init__(**kwargs)
self.resource_type = None
self.sku = None
self.capacity = None
[docs]class VirtualMachineScaleSetSkuCapacity(msrest.serialization.Model):
"""Describes scaling information of a sku.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar minimum: The minimum capacity.
:vartype minimum: long
:ivar maximum: The maximum capacity that can be set.
:vartype maximum: long
:ivar default_capacity: The default capacity.
:vartype default_capacity: long
:ivar scale_type: The scale type applicable to the sku. Possible values include: "Automatic",
"None".
:vartype scale_type: str or
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetSkuScaleType
"""
_validation = {
'minimum': {'readonly': True},
'maximum': {'readonly': True},
'default_capacity': {'readonly': True},
'scale_type': {'readonly': True},
}
_attribute_map = {
'minimum': {'key': 'minimum', 'type': 'long'},
'maximum': {'key': 'maximum', 'type': 'long'},
'default_capacity': {'key': 'defaultCapacity', 'type': 'long'},
'scale_type': {'key': 'scaleType', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(VirtualMachineScaleSetSkuCapacity, self).__init__(**kwargs)
self.minimum = None
self.maximum = None
self.default_capacity = None
self.scale_type = None
[docs]class VirtualMachineScaleSetStorageProfile(msrest.serialization.Model):
"""Describes a virtual machine scale set storage profile.
:param image_reference: The image reference.
:type image_reference: ~azure.mgmt.compute.v2016_04_30_preview.models.ImageReference
:param os_disk: The OS disk.
:type os_disk: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetOSDisk
:param data_disks: The data disks.
:type data_disks:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetDataDisk]
"""
_attribute_map = {
'image_reference': {'key': 'imageReference', 'type': 'ImageReference'},
'os_disk': {'key': 'osDisk', 'type': 'VirtualMachineScaleSetOSDisk'},
'data_disks': {'key': 'dataDisks', 'type': '[VirtualMachineScaleSetDataDisk]'},
}
def __init__(
self,
*,
image_reference: Optional["ImageReference"] = None,
os_disk: Optional["VirtualMachineScaleSetOSDisk"] = None,
data_disks: Optional[List["VirtualMachineScaleSetDataDisk"]] = None,
**kwargs
):
super(VirtualMachineScaleSetStorageProfile, self).__init__(**kwargs)
self.image_reference = image_reference
self.os_disk = os_disk
self.data_disks = data_disks
[docs]class VirtualMachineScaleSetVM(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.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param location: Required. Resource location.
:type location: str
:param tags: A set of tags. Resource tags.
:type tags: dict[str, str]
:ivar instance_id: The virtual machine instance ID.
:vartype instance_id: str
:ivar sku: The virtual machine SKU.
:vartype sku: ~azure.mgmt.compute.v2016_04_30_preview.models.Sku
:param 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**.
:type plan: ~azure.mgmt.compute.v2016_04_30_preview.models.Plan
:ivar resources: The virtual machine child extension resources.
:vartype resources:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtension]
:ivar latest_model_applied: Specifies whether the latest model has been applied to the virtual
machine.
:vartype latest_model_applied: bool
:ivar vm_id: Azure VM unique ID.
:vartype vm_id: str
:ivar instance_view: The virtual machine instance view.
:vartype instance_view:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMInstanceView
:param hardware_profile: Specifies the hardware settings for the virtual machine.
:type hardware_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.HardwareProfile
:param storage_profile: Specifies the storage settings for the virtual machine disks.
:type storage_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.StorageProfile
:param os_profile: Specifies the operating system settings for the virtual machine.
:type os_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.OSProfile
:param network_profile: Specifies the network interfaces of the virtual machine.
:type network_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.NetworkProfile
:param diagnostics_profile: Specifies the boot diagnostic settings state.
:code:`<br>`:code:`<br>`Minimum api-version: 2015-06-15.
:type diagnostics_profile: ~azure.mgmt.compute.v2016_04_30_preview.models.DiagnosticsProfile
:param availability_set: Specifies information about the availability set that the virtual
machine should be assigned to. Virtual machines specified in the same availability set are
allocated to different nodes to maximize availability. For more information about availability
sets, see `Manage the availability of virtual machines
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-
availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_. :code:`<br>`:code:`<br>`
For more information on Azure planned maintenance, see `Planned maintenance for virtual
machines in Azure <https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-
planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_
:code:`<br>`:code:`<br>` Currently, a VM can only be added to availability set at creation
time. An existing VM cannot be added to an availability set.
:type availability_set: ~azure.mgmt.compute.v2016_04_30_preview.models.SubResource
:ivar provisioning_state: The provisioning state, which only appears in the response.
:vartype provisioning_state: str
:param license_type: Specifies that the image or disk that is being used was licensed on-
premises. This element is only used for images that contain the Windows Server operating
system. :code:`<br>`:code:`<br>` Possible values are: :code:`<br>`:code:`<br>` Windows_Client
:code:`<br>`:code:`<br>` Windows_Server :code:`<br>`:code:`<br>` If this element is included in
a request for an update, the value must match the initial value. This value cannot be updated.
:code:`<br>`:code:`<br>` For more information, see `Azure Hybrid Use Benefit for Windows Server
<https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-
licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json>`_ :code:`<br>`:code:`<br>`
Minimum api-version: 2015-06-15.
:type license_type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'instance_id': {'readonly': True},
'sku': {'readonly': True},
'resources': {'readonly': True},
'latest_model_applied': {'readonly': True},
'vm_id': {'readonly': True},
'instance_view': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'instance_id': {'key': 'instanceId', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'Sku'},
'plan': {'key': 'plan', 'type': 'Plan'},
'resources': {'key': 'resources', 'type': '[VirtualMachineExtension]'},
'latest_model_applied': {'key': 'properties.latestModelApplied', 'type': 'bool'},
'vm_id': {'key': 'properties.vmId', 'type': 'str'},
'instance_view': {'key': 'properties.instanceView', 'type': 'VirtualMachineScaleSetVMInstanceView'},
'hardware_profile': {'key': 'properties.hardwareProfile', 'type': 'HardwareProfile'},
'storage_profile': {'key': 'properties.storageProfile', 'type': 'StorageProfile'},
'os_profile': {'key': 'properties.osProfile', 'type': 'OSProfile'},
'network_profile': {'key': 'properties.networkProfile', 'type': 'NetworkProfile'},
'diagnostics_profile': {'key': 'properties.diagnosticsProfile', 'type': 'DiagnosticsProfile'},
'availability_set': {'key': 'properties.availabilitySet', 'type': 'SubResource'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'license_type': {'key': 'properties.licenseType', 'type': 'str'},
}
def __init__(
self,
*,
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
):
super(VirtualMachineScaleSetVM, self).__init__(location=location, tags=tags, **kwargs)
self.instance_id = None
self.sku = None
self.plan = plan
self.resources = None
self.latest_model_applied = None
self.vm_id = None
self.instance_view = None
self.hardware_profile = hardware_profile
self.storage_profile = storage_profile
self.os_profile = os_profile
self.network_profile = network_profile
self.diagnostics_profile = diagnostics_profile
self.availability_set = availability_set
self.provisioning_state = None
self.license_type = license_type
[docs]class VirtualMachineScaleSetVMExtensionsSummary(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.
:ivar name: The extension name.
:vartype name: str
:ivar statuses_summary: The extensions information.
:vartype statuses_summary:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineStatusCodeCount]
"""
_validation = {
'name': {'readonly': True},
'statuses_summary': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'statuses_summary': {'key': 'statusesSummary', 'type': '[VirtualMachineStatusCodeCount]'},
}
def __init__(
self,
**kwargs
):
super(VirtualMachineScaleSetVMExtensionsSummary, self).__init__(**kwargs)
self.name = None
self.statuses_summary = None
[docs]class VirtualMachineScaleSetVMInstanceIDs(msrest.serialization.Model):
"""Specifies a list of virtual machine instance IDs from the VM scale set.
:param instance_ids: The virtual machine scale set instance ids. Omitting the virtual machine
scale set instance ids will result in the operation being performed on all virtual machines in
the virtual machine scale set.
:type instance_ids: list[str]
"""
_attribute_map = {
'instance_ids': {'key': 'instanceIds', 'type': '[str]'},
}
def __init__(
self,
*,
instance_ids: Optional[List[str]] = None,
**kwargs
):
super(VirtualMachineScaleSetVMInstanceIDs, self).__init__(**kwargs)
self.instance_ids = instance_ids
[docs]class VirtualMachineScaleSetVMInstanceRequiredIDs(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.
:param instance_ids: Required. The virtual machine scale set instance ids.
:type instance_ids: list[str]
"""
_validation = {
'instance_ids': {'required': True},
}
_attribute_map = {
'instance_ids': {'key': 'instanceIds', 'type': '[str]'},
}
def __init__(
self,
*,
instance_ids: List[str],
**kwargs
):
super(VirtualMachineScaleSetVMInstanceRequiredIDs, self).__init__(**kwargs)
self.instance_ids = instance_ids
[docs]class VirtualMachineScaleSetVMInstanceView(msrest.serialization.Model):
"""The instance view of a virtual machine scale set VM.
:param platform_update_domain: The Update Domain count.
:type platform_update_domain: int
:param platform_fault_domain: The Fault Domain count.
:type platform_fault_domain: int
:param rdp_thumb_print: The Remote desktop certificate thumbprint.
:type rdp_thumb_print: str
:param vm_agent: The VM Agent running on the virtual machine.
:type vm_agent: ~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineAgentInstanceView
:param disks: The disks information.
:type disks: list[~azure.mgmt.compute.v2016_04_30_preview.models.DiskInstanceView]
:param extensions: The extensions information.
:type extensions:
list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineExtensionInstanceView]
:param boot_diagnostics: Boot Diagnostics is a debugging feature which allows you to view
Console Output and Screenshot to diagnose VM status. :code:`<br>`:code:`<br>` You can easily
view the output of your console log. :code:`<br>`:code:`<br>` Azure also enables you to see a
screenshot of the VM from the hypervisor.
:type boot_diagnostics:
~azure.mgmt.compute.v2016_04_30_preview.models.BootDiagnosticsInstanceView
:param statuses: The resource status information.
:type statuses: list[~azure.mgmt.compute.v2016_04_30_preview.models.InstanceViewStatus]
:param placement_group_id: The placement group in which the VM is running. If the VM is
deallocated it will not have a placementGroupId.
:type placement_group_id: str
"""
_attribute_map = {
'platform_update_domain': {'key': 'platformUpdateDomain', 'type': 'int'},
'platform_fault_domain': {'key': 'platformFaultDomain', 'type': 'int'},
'rdp_thumb_print': {'key': 'rdpThumbPrint', 'type': 'str'},
'vm_agent': {'key': 'vmAgent', 'type': 'VirtualMachineAgentInstanceView'},
'disks': {'key': 'disks', 'type': '[DiskInstanceView]'},
'extensions': {'key': 'extensions', 'type': '[VirtualMachineExtensionInstanceView]'},
'boot_diagnostics': {'key': 'bootDiagnostics', 'type': 'BootDiagnosticsInstanceView'},
'statuses': {'key': 'statuses', 'type': '[InstanceViewStatus]'},
'placement_group_id': {'key': 'placementGroupId', 'type': 'str'},
}
def __init__(
self,
*,
platform_update_domain: Optional[int] = None,
platform_fault_domain: Optional[int] = None,
rdp_thumb_print: Optional[str] = None,
vm_agent: Optional["VirtualMachineAgentInstanceView"] = None,
disks: Optional[List["DiskInstanceView"]] = None,
extensions: Optional[List["VirtualMachineExtensionInstanceView"]] = None,
boot_diagnostics: Optional["BootDiagnosticsInstanceView"] = None,
statuses: Optional[List["InstanceViewStatus"]] = None,
placement_group_id: Optional[str] = None,
**kwargs
):
super(VirtualMachineScaleSetVMInstanceView, self).__init__(**kwargs)
self.platform_update_domain = platform_update_domain
self.platform_fault_domain = platform_fault_domain
self.rdp_thumb_print = rdp_thumb_print
self.vm_agent = vm_agent
self.disks = disks
self.extensions = extensions
self.boot_diagnostics = boot_diagnostics
self.statuses = statuses
self.placement_group_id = placement_group_id
[docs]class VirtualMachineScaleSetVMListResult(msrest.serialization.Model):
"""The List Virtual Machine Scale Set VMs operation response.
All required parameters must be populated in order to send to Azure.
:param value: Required. The list of virtual machine scale sets VMs.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVM]
:param next_link: The uri to fetch the next page of Virtual Machine Scale Set VMs. Call
ListNext() with this to fetch the next page of VMSS VMs.
:type next_link: str
"""
_validation = {
'value': {'required': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineScaleSetVM]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(
self,
*,
value: List["VirtualMachineScaleSetVM"],
next_link: Optional[str] = None,
**kwargs
):
super(VirtualMachineScaleSetVMListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class VirtualMachineScaleSetVMProfile(msrest.serialization.Model):
"""Describes a virtual machine scale set virtual machine profile.
:param os_profile: The virtual machine scale set OS profile.
:type os_profile:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetOSProfile
:param storage_profile: The virtual machine scale set storage profile.
:type storage_profile:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetStorageProfile
:param network_profile: The virtual machine scale set network profile.
:type network_profile:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetNetworkProfile
:param extension_profile: The virtual machine scale set extension profile.
:type extension_profile:
~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetExtensionProfile
"""
_attribute_map = {
'os_profile': {'key': 'osProfile', 'type': 'VirtualMachineScaleSetOSProfile'},
'storage_profile': {'key': 'storageProfile', 'type': 'VirtualMachineScaleSetStorageProfile'},
'network_profile': {'key': 'networkProfile', 'type': 'VirtualMachineScaleSetNetworkProfile'},
'extension_profile': {'key': 'extensionProfile', 'type': 'VirtualMachineScaleSetExtensionProfile'},
}
def __init__(
self,
*,
os_profile: Optional["VirtualMachineScaleSetOSProfile"] = None,
storage_profile: Optional["VirtualMachineScaleSetStorageProfile"] = None,
network_profile: Optional["VirtualMachineScaleSetNetworkProfile"] = None,
extension_profile: Optional["VirtualMachineScaleSetExtensionProfile"] = None,
**kwargs
):
super(VirtualMachineScaleSetVMProfile, self).__init__(**kwargs)
self.os_profile = os_profile
self.storage_profile = storage_profile
self.network_profile = network_profile
self.extension_profile = extension_profile
[docs]class VirtualMachineSize(msrest.serialization.Model):
"""Describes the properties of a VM size.
:param name: The name of the virtual machine size.
:type name: str
:param number_of_cores: The number of cores supported by the virtual machine size.
:type number_of_cores: int
:param os_disk_size_in_mb: The OS disk size, in MB, allowed by the virtual machine size.
:type os_disk_size_in_mb: int
:param resource_disk_size_in_mb: The resource disk size, in MB, allowed by the virtual machine
size.
:type resource_disk_size_in_mb: int
:param memory_in_mb: The amount of memory, in MB, supported by the virtual machine size.
:type memory_in_mb: int
:param max_data_disk_count: The maximum number of data disks that can be attached to the
virtual machine size.
:type max_data_disk_count: int
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'number_of_cores': {'key': 'numberOfCores', 'type': 'int'},
'os_disk_size_in_mb': {'key': 'osDiskSizeInMB', 'type': 'int'},
'resource_disk_size_in_mb': {'key': 'resourceDiskSizeInMB', 'type': 'int'},
'memory_in_mb': {'key': 'memoryInMB', 'type': 'int'},
'max_data_disk_count': {'key': 'maxDataDiskCount', 'type': 'int'},
}
def __init__(
self,
*,
name: Optional[str] = None,
number_of_cores: Optional[int] = None,
os_disk_size_in_mb: Optional[int] = None,
resource_disk_size_in_mb: Optional[int] = None,
memory_in_mb: Optional[int] = None,
max_data_disk_count: Optional[int] = None,
**kwargs
):
super(VirtualMachineSize, self).__init__(**kwargs)
self.name = name
self.number_of_cores = number_of_cores
self.os_disk_size_in_mb = os_disk_size_in_mb
self.resource_disk_size_in_mb = resource_disk_size_in_mb
self.memory_in_mb = memory_in_mb
self.max_data_disk_count = max_data_disk_count
[docs]class VirtualMachineSizeListResult(msrest.serialization.Model):
"""The List Virtual Machine operation response.
:param value: The list of virtual machine sizes.
:type value: list[~azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineSize]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[VirtualMachineSize]'},
}
def __init__(
self,
*,
value: Optional[List["VirtualMachineSize"]] = None,
**kwargs
):
super(VirtualMachineSizeListResult, self).__init__(**kwargs)
self.value = value
[docs]class VirtualMachineStatusCodeCount(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.
:ivar code: The instance view status code.
:vartype code: str
:ivar count: The number of instances having a particular status code.
:vartype count: int
"""
_validation = {
'code': {'readonly': True},
'count': {'readonly': True},
}
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'count': {'key': 'count', 'type': 'int'},
}
def __init__(
self,
**kwargs
):
super(VirtualMachineStatusCodeCount, self).__init__(**kwargs)
self.code = None
self.count = None
[docs]class WindowsConfiguration(msrest.serialization.Model):
"""Specifies Windows operating system settings on the virtual machine.
:param provision_vm_agent: Indicates whether virtual machine agent should be provisioned on the
virtual machine. :code:`<br>`:code:`<br>` When this property is not specified in the request
body, default behavior is to set it to true. This will ensure that VM Agent is installed on
the VM so that extensions can be added to the VM later.
:type provision_vm_agent: bool
:param enable_automatic_updates: Indicates whether virtual machine is enabled for automatic
updates.
:type enable_automatic_updates: bool
:param time_zone: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".
:type time_zone: str
:param additional_unattend_content: Specifies additional base-64 encoded XML formatted
information that can be included in the Unattend.xml file, which is used by Windows Setup.
:type additional_unattend_content:
list[~azure.mgmt.compute.v2016_04_30_preview.models.AdditionalUnattendContent]
:param win_rm: Specifies the Windows Remote Management listeners. This enables remote Windows
PowerShell.
:type win_rm: ~azure.mgmt.compute.v2016_04_30_preview.models.WinRMConfiguration
"""
_attribute_map = {
'provision_vm_agent': {'key': 'provisionVMAgent', 'type': 'bool'},
'enable_automatic_updates': {'key': 'enableAutomaticUpdates', 'type': 'bool'},
'time_zone': {'key': 'timeZone', 'type': 'str'},
'additional_unattend_content': {'key': 'additionalUnattendContent', 'type': '[AdditionalUnattendContent]'},
'win_rm': {'key': 'winRM', 'type': 'WinRMConfiguration'},
}
def __init__(
self,
*,
provision_vm_agent: Optional[bool] = None,
enable_automatic_updates: Optional[bool] = None,
time_zone: Optional[str] = None,
additional_unattend_content: Optional[List["AdditionalUnattendContent"]] = None,
win_rm: Optional["WinRMConfiguration"] = None,
**kwargs
):
super(WindowsConfiguration, self).__init__(**kwargs)
self.provision_vm_agent = provision_vm_agent
self.enable_automatic_updates = enable_automatic_updates
self.time_zone = time_zone
self.additional_unattend_content = additional_unattend_content
self.win_rm = win_rm
[docs]class WinRMConfiguration(msrest.serialization.Model):
"""Describes Windows Remote Management configuration of the VM.
:param listeners: The list of Windows Remote Management listeners.
:type listeners: list[~azure.mgmt.compute.v2016_04_30_preview.models.WinRMListener]
"""
_attribute_map = {
'listeners': {'key': 'listeners', 'type': '[WinRMListener]'},
}
def __init__(
self,
*,
listeners: Optional[List["WinRMListener"]] = None,
**kwargs
):
super(WinRMConfiguration, self).__init__(**kwargs)
self.listeners = listeners
[docs]class WinRMListener(msrest.serialization.Model):
"""Describes Protocol and thumbprint of Windows Remote Management listener.
:param protocol: Specifies the protocol of listener. :code:`<br>`:code:`<br>` Possible values
are: :code:`<br>`\ **http** :code:`<br>`:code:`<br>` **https**. Possible values include:
"Http", "Https".
:type protocol: str or ~azure.mgmt.compute.v2016_04_30_preview.models.ProtocolTypes
:param certificate_url: This is the URL of a certificate that has been uploaded to Key Vault as
a secret. For adding a secret to the Key Vault, see `Add a key or secret to the key vault
<https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add>`_. In this case, your
certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded
in UTF-8: :code:`<br>`:code:`<br>` {:code:`<br>` "data":":code:`<Base64-encoded-
certificate>`",:code:`<br>` "dataType":"pfx",:code:`<br>` "password":":code:`<pfx-file-
password>`":code:`<br>`}.
:type certificate_url: str
"""
_attribute_map = {
'protocol': {'key': 'protocol', 'type': 'str'},
'certificate_url': {'key': 'certificateUrl', 'type': 'str'},
}
def __init__(
self,
*,
protocol: Optional[Union[str, "ProtocolTypes"]] = None,
certificate_url: Optional[str] = None,
**kwargs
):
super(WinRMListener, self).__init__(**kwargs)
self.protocol = protocol
self.certificate_url = certificate_url