models Package

Classes

AccessUri

A disk access SAS uri.

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

AdditionalUnattendContent

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.

ApiEntityReference

The API entity reference.

ApiError

Api error.

ApiErrorBase

Api error base.

AvailabilitySet

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

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

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

AvailabilitySetListResult

The List Availability Set operation response.

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

BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br>``<br> You can easily view the output of your console log. <br>``<br> Azure also enables you to see a screenshot of the VM from the hypervisor.

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

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

ComputeLongRunningOperationProperties

Compute-specific operation properties, including output.

CreationData

Data used when creating a disk.

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

DataDisk

Describes a data disk.

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

DataDiskImage

Contains the data disk images information.

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

DiagnosticsProfile

Specifies the boot diagnostic settings state. <br>:code:>><<<br>Minimum api-version: 2015-06-15.

Disk

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.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk.

DiskInstanceView

The instance view of the disk.

DiskList

The List Disks operation response.

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

DiskUpdate

Disk update resource.

EncryptionSettings

Encryption settings for disk or snapshot.

GrantAccessData

Data used for requesting a SAS.

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

HardwareProfile

Specifies the hardware settings for the virtual machine.

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.

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.

ImageDataDisk

Describes a data disk.

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

ImageDiskReference

The source image used for creating the disk.

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

ImageListResult

The List Image operation response.

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

ImageOSDisk

Describes an Operating System disk.

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

ImageReference

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.

ImageStorageProfile

Describes a storage profile.

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

InnerError

Inner error details.

InstanceViewStatus

Instance view status.

KeyVaultAndKeyReference

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.

KeyVaultAndSecretReference

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

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

KeyVaultKeyReference

Describes a reference to Key Vault Key.

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

KeyVaultSecretReference

Describes a reference to Key Vault Secret.

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

LinuxConfiguration

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

ListUsagesResult

The List Usages operation response.

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

ManagedDiskParameters

The parameters of a managed disk.

NetworkInterfaceReference

Describes a network interface reference.

NetworkProfile

Specifies the network interfaces of the virtual machine.

OSDisk

Specifies information about the operating system disk used by the virtual machine. <br>``<br> For more information about disks, see About disks and VHDs for Azure virtual machines.

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

OSDiskImage

Contains the os disk image information.

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

OSProfile

Specifies the operating system settings for the virtual machine.

OperationStatusResponse

Operation status response.

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

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.

PurchasePlan

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.

Resource

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.

ResourceUpdate

The Resource model definition.

Sku

Describes a virtual machine scale set sku.

Snapshot

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.

SnapshotList

The List Snapshots operation response.

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

SnapshotUpdate

Snapshot update resource.

SourceVault

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

SshConfiguration

SSH configuration for Linux based VMs running on Azure.

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

StorageProfile

Specifies the storage settings for the virtual machine disks.

SubResource

SubResource.

SubResourceReadOnly

SubResourceReadOnly.

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

UpdateResource

The Update Resource model definition.

UpgradePolicy

Describes an upgrade policy - automatic or manual.

Usage

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.

UsageName

The Usage Names.

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

VirtualHardDisk

Describes the uri of a disk.

VirtualMachine

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.

VirtualMachineAgentInstanceView

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

VirtualMachineCaptureParameters

Capture Virtual Machine parameters.

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

VirtualMachineCaptureResult

Resource Id.

VirtualMachineExtension

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.

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

VirtualMachineExtensionImage

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.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

VirtualMachineExtensionUpdate

Describes a Virtual Machine Extension.

VirtualMachineExtensionsListResult

The List Extension operation response.

VirtualMachineIdentity

Identity for the virtual machine.

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

VirtualMachineImage

Describes a Virtual Machine Image.

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

VirtualMachineImageResource

Virtual machine image resource information.

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

VirtualMachineInstanceView

The instance view of a virtual machine.

VirtualMachineListResult

The List Virtual Machine operation response.

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

VirtualMachineScaleSet

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.

VirtualMachineScaleSetDataDisk

Describes a virtual machine scale set data disk.

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

VirtualMachineScaleSetExtension

Describes a Virtual Machine Scale Set Extension.

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

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

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

VirtualMachineScaleSetIdentity

Identity for the virtual machine scale set.

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

VirtualMachineScaleSetInstanceView

The instance view of a virtual machine scale set.

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

VirtualMachineScaleSetInstanceViewStatusesSummary

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.

VirtualMachineScaleSetListResult

The List Virtual Machine operation response.

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

VirtualMachineScaleSetListSkusResult

The Virtual Machine Scale Set List Skus operation response.

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

VirtualMachineScaleSetListWithLinkResult

The List Virtual Machine operation response.

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

VirtualMachineScaleSetManagedDiskParameters

Describes the parameters of a ScaleSet managed disk.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

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

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

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

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

VirtualMachineScaleSetSku

Describes an available virtual machine scale set sku.

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

VirtualMachineScaleSetSkuCapacity

Describes scaling information of a sku.

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

VirtualMachineScaleSetStorageProfile

Describes a virtual machine scale set storage profile.

VirtualMachineScaleSetVM

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.

VirtualMachineScaleSetVMExtensionsSummary

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.

VirtualMachineScaleSetVMInstanceIDs

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

VirtualMachineScaleSetVMInstanceRequiredIDs

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.

VirtualMachineScaleSetVMInstanceView

The instance view of a virtual machine scale set VM.

VirtualMachineScaleSetVMListResult

The List Virtual Machine Scale Set VMs operation response.

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

VirtualMachineScaleSetVMProfile

Describes a virtual machine scale set virtual machine profile.

VirtualMachineSize

Describes the properties of a VM size.

VirtualMachineSizeListResult

The List Virtual Machine operation response.

VirtualMachineStatusCodeCount

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.

WinRMConfiguration

Describes Windows Remote Management configuration of the VM.

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

Enums

AccessLevel

An enumeration.

CachingTypes

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

DiskCreateOption

This enumerates the possible sources of a disk's creation.

DiskCreateOptionTypes

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

OperatingSystemStateTypes

The OS State.

OperatingSystemTypes

The operating system of the osDiskImage.

ProtocolTypes

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

SettingNames

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

StatusLevelTypes

The level code.

StorageAccountTypes

Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.

UpgradeMode

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

VirtualMachineScaleSetSkuScaleType

The scale type applicable to the sku.

VirtualMachineSizeTypes

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