VirtualMachineScaleSet Interface

Reference

Package:: com.microsoft.azure.management.compute

public interface VirtualMachineScaleSet extends GroupableResource<ComputeManager, VirtualMachineScaleSetInner>,Refreshable,Updatable<VirtualMachineScaleSet.UpdateStages.WithPrimaryLoadBalancer>

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

Method Summary

Modifier and Type	Method and Description
Set<AvailabilityZoneId>	availabilityZones()
int	capacity()
String	computerNamePrefix()
void	deallocate() Shuts down the virtual machines in the scale set and releases its compute resources.
Completable	deallocateAsync() Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.
ServiceFuture<Void>	deallocateAsync(ServiceCallback<Void> callback) Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.
Map<String, VirtualMachineScaleSetExtension>	extensions()
VirtualMachineScaleSetNetworkInterface	getNetworkInterfaceByInstanceId(String instanceId, String name) Gets a network interface associated with a virtual machine scale set instance.
LoadBalancer	getPrimaryInternalLoadBalancer()
LoadBalancer	getPrimaryInternetFacingLoadBalancer()
Network	getPrimaryNetwork() A primary internal load balancer associated with the primary network interfaces of the scale set virtual machine will be also belong to this network
boolean	isManagedDiskEnabled()
boolean	isManagedServiceIdentityEnabled()
PagedList<VirtualMachineScaleSetSku>	listAvailableSkus()
PagedList<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfaces()
PagedList<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfacesByInstanceId(String virtualMachineInstanceId) Lists the network interface associated with a specific virtual machine instance in the scale set.
Map<String, LoadBalancerBackend>	listPrimaryInternalLoadBalancerBackends()
Map<String, LoadBalancerInboundNatPool>	listPrimaryInternalLoadBalancerInboundNatPools()
Map<String, LoadBalancerBackend>	listPrimaryInternetFacingLoadBalancerBackends()
Map<String, LoadBalancerInboundNatPool>	listPrimaryInternetFacingLoadBalancerInboundNatPools()
String	managedServiceIdentityPrincipalId()
String	managedServiceIdentityTenantId()
VirtualMachineScaleSetNetworkProfile	networkProfile()
CachingTypes	osDiskCachingType()
String	osDiskName()
OperatingSystemTypes	osType()
boolean	overProvisionEnabled()
void	powerOff() Powers off (stops) the virtual machines in the scale set.
Completable	powerOffAsync() Powers off (stops) the virtual machines in the scale set asynchronously.
ServiceFuture<Void>	powerOffAsync(ServiceCallback<Void> callback) Powers off (stops) the virtual machines in the scale set asynchronously.
List<String>	primaryPublicIPAddressIds()
void	reimage() Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
Completable	reimageAsync() Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
ServiceFuture<Void>	reimageAsync(ServiceCallback<Void> callback) Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
void	restart() Restarts the virtual machines in the scale set.
Completable	restartAsync() Restarts the virtual machines in the scale set asynchronously.
ServiceFuture<Void>	restartAsync(ServiceCallback<Void> callback) Restarts the virtual machines in the scale set asynchronously.
VirtualMachineScaleSetSkuTypes	sku()
void	start() Starts the virtual machines in the scale set.
Completable	startAsync() Starts the virtual machines in the scale set asynchronously.
ServiceFuture<Void>	startAsync(ServiceCallback<Void> callback) Starts the virtual machines in the scale set asynchronously.
VirtualMachineScaleSetStorageProfile	storageProfile()
UpgradeMode	upgradeModel()
List<String>	vhdContainers()
VirtualMachineScaleSetVMs	virtualMachines()

Inherited Members

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type() Updatable<T>.update()

Method Details

availabilityZones

public Set availabilityZones()

Returns:

the availability zones assigned to virtual machine scale set.

capacity

public int capacity()

Returns:

the number of virtual machine instances in the scale set

computerNamePrefix

public String computerNamePrefix()

Returns:

the name prefix of the virtual machines in the scale set

deallocate

public void deallocate()

Shuts down the virtual machines in the scale set and releases its compute resources.

deallocateAsync

public Completable deallocateAsync()

Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.

Returns:

a representation of the deferred computation of this call

deallocateAsync

public ServiceFuture deallocateAsync(ServiceCallback callback)

Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

extensions

public Map extensions()

Returns:

the extensions attached to the virtual machines in the scale set

getNetworkInterfaceByInstanceId

public VirtualMachineScaleSetNetworkInterface getNetworkInterfaceByInstanceId(String instanceId, String name)

Gets a network interface associated with a virtual machine scale set instance.

Parameters:

instanceId - the virtual machine scale set vm instance ID

name - the network interface name

Returns:

the network interface

getPrimaryInternalLoadBalancer

public LoadBalancer getPrimaryInternalLoadBalancer()

Returns:

the internal load balancer associated with the primary network interface of the virtual machines in the scale set

Throws:

IOException - the IO exception

getPrimaryInternetFacingLoadBalancer

public LoadBalancer getPrimaryInternetFacingLoadBalancer()

Returns:

the Internet-facing load balancer associated with the primary network interface of the virtual machines in the scale set.

Throws:

IOException - the IO exception

getPrimaryNetwork

public Network getPrimaryNetwork()

A primary internal load balancer associated with the primary network interfaces of the scale set virtual machine will be also belong to this network

Returns:

the virtual network associated with the primary network interfaces of the virtual machines in the scale set.

Throws:

IOException - the IO exception

isManagedDiskEnabled

public boolean isManagedDiskEnabled()

Returns:

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

isManagedServiceIdentityEnabled

public boolean isManagedServiceIdentityEnabled()

Returns:

true if Managed Service Identity is enabled for the virtual machine scale set

listAvailableSkus

public PagedList listAvailableSkus()

Returns:

available SKUs for the virtual machine scale set, including the minimum and maximum virtual machine instances allowed for a particular SKU

listNetworkInterfaces

public PagedList listNetworkInterfaces()

Returns:

the network interfaces associated with all virtual machine instances in a scale set

listNetworkInterfacesByInstanceId

public PagedList listNetworkInterfacesByInstanceId(String virtualMachineInstanceId)

Lists the network interface associated with a specific virtual machine instance in the scale set.

Parameters:

virtualMachineInstanceId - the instance ID

Returns:

the network interfaces

listPrimaryInternalLoadBalancerBackends

public Map listPrimaryInternalLoadBalancerBackends()

Returns:

the internal load balancer's backends associated with the primary network interface of the virtual machines in the scale set

Throws:

IOException - the IO exception

listPrimaryInternalLoadBalancerInboundNatPools

public Map listPrimaryInternalLoadBalancerInboundNatPools()

Returns:

the inbound NAT pools of the internal load balancer associated with the primary network interface of the virtual machines in the scale set, if any.

Throws:

IOException - the IO exception

listPrimaryInternetFacingLoadBalancerBackends

public Map listPrimaryInternetFacingLoadBalancerBackends()

Returns:

the Internet-facing load balancer's backends associated with the primary network interface of the virtual machines in the scale set

Throws:

IOException - the IO exception

listPrimaryInternetFacingLoadBalancerInboundNatPools

public Map listPrimaryInternetFacingLoadBalancerInboundNatPools()

Returns:

the Internet-facing load balancer's inbound NAT pool associated with the primary network interface of the virtual machines in the scale set

Throws:

IOException - the IO exception

managedServiceIdentityPrincipalId

public String managedServiceIdentityPrincipalId()

Returns:

the Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine scale set.

managedServiceIdentityTenantId

public String managedServiceIdentityTenantId()

Returns:

the Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine scale set.

networkProfile

public VirtualMachineScaleSetNetworkProfile networkProfile()

Returns:

the network profile

osDiskCachingType

public CachingTypes osDiskCachingType()

Returns:

the operating system disk caching type

osDiskName

public String osDiskName()

Returns:

the name of the OS disk of virtual machines in the scale set

osType

public OperatingSystemTypes osType()

Returns:

the operating system of the virtual machines in the scale set

overProvisionEnabled

public boolean overProvisionEnabled()

Returns:

true if over provision is enabled for the virtual machines, false otherwise

powerOff

public void powerOff()

Powers off (stops) the virtual machines in the scale set.

powerOffAsync

public Completable powerOffAsync()

Powers off (stops) the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

powerOffAsync

public ServiceFuture powerOffAsync(ServiceCallback callback)

Powers off (stops) the virtual machines in the scale set asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

primaryPublicIPAddressIds

public List primaryPublicIPAddressIds()

Returns:

the list of IDs of the public IP addresses associated with the primary Internet-facing load balancer of the scale set

Throws:

IOException - the IO exception

reimage

public void reimage()

Re-images (updates the version of the installed operating system) the virtual machines in the scale set.

reimageAsync

public Completable reimageAsync()

Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

reimageAsync

public ServiceFuture reimageAsync(ServiceCallback callback)

Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

restart

public void restart()

Restarts the virtual machines in the scale set.

restartAsync

public Completable restartAsync()

Restarts the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

restartAsync

public ServiceFuture restartAsync(ServiceCallback callback)

Restarts the virtual machines in the scale set asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

sku

public VirtualMachineScaleSetSkuTypes sku()

Returns:

the SKU of the virtual machines in the scale set

start

public void start()

Starts the virtual machines in the scale set.

startAsync

public Completable startAsync()

Starts the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

startAsync

public ServiceFuture startAsync(ServiceCallback callback)

Starts the virtual machines in the scale set asynchronously.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

storageProfile

public VirtualMachineScaleSetStorageProfile storageProfile()

Returns:

the storage profile

upgradeModel

public UpgradeMode upgradeModel()

Returns:

the upgrade model

vhdContainers

public List vhdContainers()

Returns:

the URL to storage containers that store the VHDs of the virtual machines in the scale set