IVirtualMachineScaleSetVM Interface

Definition

An immutable client-side representation of a virtual machine instance in an Azure virtual machine scale set.

public interface IVirtualMachineScaleSetVM : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IChildResource<Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSet>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.Compute.Fluent.Models.VirtualMachineScaleSetVMInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasParent<Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSet>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IResource, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSetVM>
type IVirtualMachineScaleSetVM = interface
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IChildResource<IVirtualMachineScaleSet>
    interface IHasParent<IVirtualMachineScaleSet>
    interface IRefreshable<IVirtualMachineScaleSetVM>
    interface IHasInner<VirtualMachineScaleSetVMInner>
Public Interface IVirtualMachineScaleSetVM
Implements IChildResource(Of IVirtualMachineScaleSet), IHasInner(Of VirtualMachineScaleSetVMInner), IHasParent(Of IVirtualMachineScaleSet), IRefreshable(Of IVirtualMachineScaleSetVM), IResource
Implements

Properties

AdministratorUserName

Gets the name of the admin user.

AvailabilitySetId

Gets the resource ID of the availability set that this virtual machine instance belongs to.

BootDiagnosticEnabled

Gets true if the boot diagnostic is enabled, false otherwise.

BootDiagnosticStorageAccountUri

Gets the URI to the storage account storing boot diagnostics log.

ComputerName

Gets the virtual machine instance computer name with the VM scale set prefix.

DataDisks

Gets the managed data disks associated with this virtual machine instance, indexed by LUN.

DiagnosticsProfile

Gets the diagnostics profile of the virtual machine instance.

Extensions

Gets the extensions associated with the virtual machine instance, indexed by name.

Inner (Inherited from IHasInner<T>)
InstanceId

Gets the instance ID assigned to this virtual machine instance.

InstanceView

Gets the instance view of the virtual machine instance. To get the latest instance view use refreshInstanceView().

IsLatestScaleSetUpdateApplied

Gets true if the latest scale set model changes are applied to the virtual machine instance.

IsLinuxPasswordAuthenticationEnabled

Gets true if this is a Linux virtual machine and password based login is enabled, false otherwise.

IsManagedDiskEnabled

Gets true if managed disk is used for the virtual machine's disks (os, data).

IsOSBasedOnCustomImage

Gets true if the operating system of the virtual machine instance is based on custom image.

IsOSBasedOnPlatformImage

Gets true if the operating system of the virtual machine instance is based on platform image.

IsOSBasedOnStoredImage

Gets true if the operating system of the virtual machine instance is based on stored image.

IsWindowsAutoUpdateEnabled

Gets true if this is a Windows virtual machine and automatic update is turned on, false otherwise.

IsWindowsVMAgentProvisioned

Gets true if this is a Windows virtual machine and VM agent is provisioned, false otherwise.

NetworkInterfaceIds

Gets the list of resource ID of network interface associated with the virtual machine instance.

OSDiskCachingType

Gets the caching type of the operating system disk.

OSDiskId

Gets resource ID of the managed disk backing OS disk.

OSDiskName

Gets the name of the operating system disk.

OSDiskSizeInGB

Gets the size of the operating system disk.

OSProfile

Gets the operating system profile of an virtual machine instance.

OSType

Gets the operating system type.

OSUnmanagedDiskVhdUri

Gets VHD URI to the operating system disk.

Parent

Gets the parent of this child resource.

(Inherited from IHasParent<ParentT>)
PlatformImageReference

Gets reference to the platform image that the virtual machine instance operating system is based on, null will be returned if the operating system is based on custom image.

PowerState

Gets the power state of the virtual machine instance.

PrimaryNetworkInterfaceId

Gets resource ID of primary network interface associated with virtual machine instance.

Region (Inherited from IResource)
RegionName (Inherited from IResource)
Size

Gets virtual machine instance size.

Sku

Gets the SKU of the virtual machine instance, this will be SKU used while creating the parent virtual machine scale set.

StorageProfile

Gets the storage profile of the virtual machine instance.

StoredImageUnmanagedVhdUri

Gets VHD URI of the custom image that the virtual machine instance operating system is based on, null will be returned if the operating system is based on platform image.

Tags (Inherited from IResource)
Type (Inherited from IResource)
UnmanagedDataDisks

Gets the unmanaged data disks associated with this virtual machine instance, indexed by LUN.

WindowsTimeZone

Gets the time zone of the Windows virtual machine.

Methods

Deallocate()

Shuts down the virtual machine instance and releases the associated compute resources.

DeallocateAsync(CancellationToken)

Shuts down the virtual machine instance and releases the associated compute resources.

Delete()

Deletes the virtual machine instance.

DeleteAsync(CancellationToken)

Deletes the virtual machine instance.

GetNetworkInterface(String)

Gets a network interface associated with this virtual machine instance.

GetOSCustomImage()
GetOSPlatformImage()
ListNetworkInterfaces()
PowerOff()

Stops the virtual machine instance.

PowerOffAsync(CancellationToken)

Stops the virtual machine instance.

Refresh()

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
RefreshInstanceView()

Refreshes the instance view.

Reimage()

Updates the version of the installed operating system in the virtual machine instance.

ReimageAsync(CancellationToken)

Updates the version of the installed operating system in the virtual machine instance.

Restart()

Restarts the virtual machine instance.

RestartAsync(CancellationToken)

Restarts the virtual machine instance.

Start()

Starts the virtual machine instance.

StartAsync(CancellationToken)

Starts the virtual machine instance.

Applies to