Share via


VirtualMachineScaleSetVmData Class

Definition

A class representing the VirtualMachineScaleSetVm data model. Describes a virtual machine scale set virtual machine.

public class VirtualMachineScaleSetVmData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmData>
type VirtualMachineScaleSetVmData = class
    inherit TrackedResourceData
    interface IJsonModel<VirtualMachineScaleSetVmData>
    interface IPersistableModel<VirtualMachineScaleSetVmData>
Public Class VirtualMachineScaleSetVmData
Inherits TrackedResourceData
Implements IJsonModel(Of VirtualMachineScaleSetVmData), IPersistableModel(Of VirtualMachineScaleSetVmData)
Inheritance
VirtualMachineScaleSetVmData
Implements

Constructors

VirtualMachineScaleSetVmData(AzureLocation)

Initializes a new instance of VirtualMachineScaleSetVmData.

Properties

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.

AvailabilitySetId

Gets or sets Id.

BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

ETag

Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.

HardwareProfile

Specifies the hardware settings for the virtual machine.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

The identity of the virtual machine, if configured.

InstanceId

The virtual machine instance ID.

InstanceView

The virtual machine instance view.

LatestModelApplied

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

LicenseType

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
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.

Name

The name of the resource.

(Inherited from ResourceData)
NetworkInterfaceConfigurations

The list of network configurations.

NetworkProfile

Specifies the network interfaces of the virtual machine.

OSProfile

Specifies the operating system settings for the virtual machine.

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.

ProtectionPolicy

Specifies the protection policy of the virtual machine.

ProvisioningState

The provisioning state, which only appears in the response.

Resources

The virtual machine child extension resources.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

Sku

The virtual machine SKU.

StorageProfile

Specifies the storage settings for the virtual machine disks.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
TimeCreated

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

UserData

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

VmId

Azure VM unique ID.

Zones

The virtual machine zones.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<VirtualMachineScaleSetVmData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<VirtualMachineScaleSetVmData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<VirtualMachineScaleSetVmData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<VirtualMachineScaleSetVmData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<VirtualMachineScaleSetVmData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to