Class VirtualMachineScaleSetVM

Describes a virtual machine scale set virtual machine.

Inheritance

Object

Resource

VirtualMachineScaleSetVM

Inherited Members

Resource.Id

Resource.Location

Resource.Name

Resource.Tags

Resource.Type

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Compute.dll

Syntax

[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualMachineScaleSetVM : Microsoft.Azure.Management.Compute.Models.Resource

Constructors

VirtualMachineScaleSetVM()

Initializes a new instance of the VirtualMachineScaleSetVM class.

Declaration

public VirtualMachineScaleSetVM ();

VirtualMachineScaleSetVM(String, String, String, String, IDictionary<String,String>, String, Sku, Nullable<Boolean>, String, VirtualMachineScaleSetVMInstanceView, HardwareProfile, StorageProfile, AdditionalCapabilities, OSProfile, NetworkProfile, VirtualMachineScaleSetVMNetworkProfileConfiguration, DiagnosticsProfile, SubResource, String, String, String, VirtualMachineScaleSetVMProtectionPolicy, Plan, IList<VirtualMachineExtension>, IList<String>)

Initializes a new instance of the VirtualMachineScaleSetVM class.

Declaration

public VirtualMachineScaleSetVM (string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, string instanceId = null, Microsoft.Azure.Management.Compute.Models.Sku sku = null, Nullable<bool> latestModelApplied = null, string vmId = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMInstanceView instanceView = null, Microsoft.Azure.Management.Compute.Models.HardwareProfile hardwareProfile = null, Microsoft.Azure.Management.Compute.Models.StorageProfile storageProfile = null, Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities additionalCapabilities = null, Microsoft.Azure.Management.Compute.Models.OSProfile osProfile = null, Microsoft.Azure.Management.Compute.Models.NetworkProfile networkProfile = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration = null, Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile diagnosticsProfile = null, Microsoft.Azure.Management.Compute.Models.SubResource availabilitySet = null, string provisioningState = null, string licenseType = null, string modelDefinitionApplied = null, Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMProtectionPolicy protectionPolicy = null, Microsoft.Azure.Management.Compute.Models.Plan plan = null, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> resources = null, System.Collections.Generic.IList<string> zones = null);

Parameters

String location

Resource location

String id

Resource Id

String name

Resource name

String type

Resource type

IDictionary<String,String> tags

Resource tags

String instanceId

The virtual machine instance ID.

Sku sku

The virtual machine SKU.

Nullable<Boolean> latestModelApplied

Specifies whether the latest model has been applied to the virtual machine.

String vmId

Azure VM unique ID.

VirtualMachineScaleSetVMInstanceView instanceView

The virtual machine instance view.

HardwareProfile hardwareProfile

Specifies the hardware settings for the virtual machine.

StorageProfile storageProfile

Specifies the storage settings for the virtual machine disks.

AdditionalCapabilities additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

OSProfile osProfile

Specifies the operating system settings for the virtual machine.

NetworkProfile networkProfile

Specifies the network interfaces of the virtual machine.

VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

DiagnosticsProfile diagnosticsProfile

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

SubResource 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. For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

String provisioningState

The provisioning state, which only appears in the response.

String licenseType

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. Possible values are: Windows_Client Windows_Server If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. For more information, see Azure Hybrid Use Benefit for Windows Server Minimum api-version: 2015-06-15

String modelDefinitionApplied

Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.

VirtualMachineScaleSetVMProtectionPolicy protectionPolicy

Specifies the protection policy of the virtual machine.

Plan plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

IList<VirtualMachineExtension> resources

The virtual machine child extension resources.

IList<String> zones

The virtual machine zones.

Properties

AdditionalCapabilities

Gets or sets specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.additionalCapabilities")]
public Microsoft.Azure.Management.Compute.Models.AdditionalCapabilities AdditionalCapabilities { get; set; }

Property Value

AdditionalCapabilities

AvailabilitySet

Gets or sets 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. For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.availabilitySet")]
public Microsoft.Azure.Management.Compute.Models.SubResource AvailabilitySet { get; set; }

Property Value

SubResource

DiagnosticsProfile

Gets or sets specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.diagnosticsProfile")]
public Microsoft.Azure.Management.Compute.Models.DiagnosticsProfile DiagnosticsProfile { get; set; }

Property Value

DiagnosticsProfile

HardwareProfile

Gets or sets specifies the hardware settings for the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.hardwareProfile")]
public Microsoft.Azure.Management.Compute.Models.HardwareProfile HardwareProfile { get; set; }

Property Value

HardwareProfile

InstanceId

Gets the virtual machine instance ID.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="instanceId")]
public string InstanceId { get; }

Property Value

String

InstanceView

Gets the virtual machine instance view.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.instanceView")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMInstanceView InstanceView { get; }

Property Value

VirtualMachineScaleSetVMInstanceView

LatestModelApplied

Gets specifies whether the latest model has been applied to the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.latestModelApplied")]
public Nullable<bool> LatestModelApplied { get; }

Property Value

Nullable<Boolean>

LicenseType

Gets or sets 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. Possible values are: Windows_Client Windows_Server If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. For more information, see Azure Hybrid Use Benefit for Windows Server Minimum api-version: 2015-06-15

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.licenseType")]
public string LicenseType { get; set; }

Property Value

String

ModelDefinitionApplied

Gets specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.modelDefinitionApplied")]
public string ModelDefinitionApplied { get; }

Property Value

String

NetworkProfile

Gets or sets specifies the network interfaces of the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.networkProfile")]
public Microsoft.Azure.Management.Compute.Models.NetworkProfile NetworkProfile { get; set; }

Property Value

NetworkProfile

NetworkProfileConfiguration

Gets or sets specifies the network profile configuration of the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.networkProfileConfiguration")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMNetworkProfileConfiguration NetworkProfileConfiguration { get; set; }

Property Value

VirtualMachineScaleSetVMNetworkProfileConfiguration

OsProfile

Gets or sets specifies the operating system settings for the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.osProfile")]
public Microsoft.Azure.Management.Compute.Models.OSProfile OsProfile { get; set; }

Property Value

OSProfile

Plan

Gets or sets 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.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="plan")]
public Microsoft.Azure.Management.Compute.Models.Plan Plan { get; set; }

Property Value

Plan

ProtectionPolicy

Gets or sets specifies the protection policy of the virtual machine.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.protectionPolicy")]
public Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetVMProtectionPolicy ProtectionPolicy { get; set; }

Property Value

VirtualMachineScaleSetVMProtectionPolicy

ProvisioningState

Gets the provisioning state, which only appears in the response.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.provisioningState")]
public string ProvisioningState { get; }

Property Value

String

Resources

Gets the virtual machine child extension resources.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="resources")]
public System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension> Resources { get; }

Property Value

IList<VirtualMachineExtension>

Sku

Gets the virtual machine SKU.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="sku")]
public Microsoft.Azure.Management.Compute.Models.Sku Sku { get; }

Property Value

Sku

StorageProfile

Gets or sets specifies the storage settings for the virtual machine disks.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.storageProfile")]
public Microsoft.Azure.Management.Compute.Models.StorageProfile StorageProfile { get; set; }

Property Value

StorageProfile

VmId

Gets azure VM unique ID.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties.vmId")]
public string VmId { get; }

Property Value

String

Zones

Gets the virtual machine zones.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="zones")]
public System.Collections.Generic.IList<string> Zones { get; }

Property Value

IList<String>

Methods

Validate()

Validate the object.

Declaration

public override void Validate ();

Exceptions

ValidationException

Thrown if validation fails