Package version:

Interface VirtualMachineScaleSetVM

Describes a virtual machine scale set virtual machine.

interface VirtualMachineScaleSetVM {
    additionalCapabilities?: AdditionalCapabilities;
    availabilitySet?: SubResource;
    diagnosticsProfile?: DiagnosticsProfile;
    etag?: string;
    hardwareProfile?: HardwareProfile;
    id?: string;
    identity?: VirtualMachineIdentity;
    instanceId?: string;
    instanceView?: VirtualMachineScaleSetVMInstanceView;
    latestModelApplied?: boolean;
    licenseType?: string;
    location: string;
    modelDefinitionApplied?: string;
    name?: string;
    networkProfile?: NetworkProfile;
    networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration;
    osProfile?: OSProfile;
    plan?: Plan;
    protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy;
    provisioningState?: string;
    resilientVMDeletionStatus?: string;
    resources?: VirtualMachineExtension[];
    securityProfile?: SecurityProfile;
    sku?: Sku;
    storageProfile?: StorageProfile;
    tags?: {
        [propertyName: string]: string;
    };
    timeCreated?: any;
    type?: string;
    userData?: string;
    vmId?: string;
    zones?: string[];
}

Hierarchy (view full)

Properties

additionalCapabilities? availabilitySet? diagnosticsProfile? etag? hardwareProfile? id? identity? instanceId? instanceView? latestModelApplied? licenseType? location modelDefinitionApplied? name? networkProfile? networkProfileConfiguration? osProfile? plan? protectionPolicy? provisioningState? resilientVMDeletionStatus? resources? securityProfile? sku? storageProfile? tags? timeCreated? type? userData? vmId? zones?

Properties

OptionaladditionalCapabilities

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.

OptionalavailabilitySet

availabilitySet?: SubResource

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates 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.

OptionaldiagnosticsProfile

diagnosticsProfile?: DiagnosticsProfile

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

Optional Readonlyetag

etag?: string

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. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalhardwareProfile

hardwareProfile?: HardwareProfile

Specifies the hardware settings for the virtual machine.

Optional Readonlyid

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optionalidentity

identity?: VirtualMachineIdentity

The identity of the virtual machine, if configured.

Optional ReadonlyinstanceId

instanceId?: string

The virtual machine instance ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyinstanceView

instanceView?: VirtualMachineScaleSetVMInstanceView

The virtual machine instance view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlylatestModelApplied

latestModelApplied?: boolean

Specifies whether the latest model has been applied to the virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

OptionallicenseType

licenseType?: string

Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see Azure Hybrid Use Benefit for Windows Server

Azure Hybrid Use Benefit for Linux Server

Minimum api-version: 2015-06-15

location

location: string

Resource location

Optional ReadonlymodelDefinitionApplied

modelDefinitionApplied?: string

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. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyname

name?: string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

OptionalnetworkProfile

networkProfile?: NetworkProfile

Specifies the network interfaces of the virtual machine.

OptionalnetworkProfileConfiguration

networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

OptionalosProfile

osProfile?: OSProfile

Specifies the operating system settings for the virtual machine.

Optionalplan

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.

OptionalprotectionPolicy

protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy

Specifies the protection policy of the virtual machine.

Optional ReadonlyprovisioningState

provisioningState?: string

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalresilientVMDeletionStatus

resilientVMDeletionStatus?: string

Specifies the resilient VM deletion status for the virtual machine.

Optional Readonlyresources

resources?: VirtualMachineExtension[]

The virtual machine child extension resources. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalsecurityProfile

securityProfile?: SecurityProfile

Specifies the Security related profile settings for the virtual machine.

Optional Readonlysku

sku?: Sku

The virtual machine SKU. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalstorageProfile

storageProfile?: StorageProfile

Specifies the storage settings for the virtual machine disks.

Optionaltags

tags?: {
    [propertyName: string]: string;
}

Resource tags

Optional ReadonlytimeCreated

timeCreated?: any

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlytype

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

OptionaluserData

userData?: string

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

Optional ReadonlyvmId

vmId?: string

Azure VM unique ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyzones

zones?: string[]

The virtual machine zones. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility