com.microsoft.azure.management.compute

Interface VirtualMachineScaleSet

All Superinterfaces:

com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<VirtualMachineScaleSet>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource, com.microsoft.azure.management.resources.fluentcore.model.Updatable<VirtualMachineScaleSet.UpdateStages.WithPrimaryLoadBalancer>, com.microsoft.azure.management.resources.fluentcore.model.Wrapper<com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetInner>

public interface VirtualMachineScaleSet
extends com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<VirtualMachineScaleSet>, com.microsoft.azure.management.resources.fluentcore.model.Wrapper<com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetInner>, com.microsoft.azure.management.resources.fluentcore.model.Updatable<VirtualMachineScaleSet.UpdateStages.WithPrimaryLoadBalancer>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VirtualMachineScaleSet.Definition The entirety of the load balancer definition.
static interface	VirtualMachineScaleSet.DefinitionStages Grouping of virtual machine scale set definition stages.
static interface	VirtualMachineScaleSet.Update The entirety of the load balancer update.
static interface	VirtualMachineScaleSet.UpdateStages Grouping of virtual machine scale set update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Method Summary

Methods

Modifier and Type	Method and Description
int	capacity()
String	computerNamePrefix()
void	deallocate() Shuts down the virtual machines in the scale set and releases its compute resources.
Map<String,VirtualMachineScaleSetExtension>	extensions()
com.microsoft.azure.management.network.LoadBalancer	getPrimaryInternalLoadBalancer()
com.microsoft.azure.management.network.LoadBalancer	getPrimaryInternetFacingLoadBalancer()
com.microsoft.azure.management.network.Network	getPrimaryNetwork()
com.microsoft.azure.PagedList<VirtualMachineScaleSetSku>	listAvailableSkus()
Map<String,com.microsoft.azure.management.network.Backend>	listPrimaryInternalLoadBalancerBackends()
Map<String,com.microsoft.azure.management.network.InboundNatPool>	listPrimaryInternalLoadBalancerInboundNatPools()
Map<String,com.microsoft.azure.management.network.Backend>	listPrimaryInternetFacingLoadBalancerBackends()
Map<String,com.microsoft.azure.management.network.InboundNatPool>	listPrimaryInternetFacingLoadBalancerInboundNatPools()
VirtualMachineScaleSetNetworkProfile	networkProfile()
CachingTypes	osDiskCachingType()
String	osDiskName()
OperatingSystemTypes	osType()
boolean	overProvisionEnabled()
void	powerOff() Powers off (stops) the virtual machines in the scale set.
List<String>	primaryPublicIpAddressIds()
void	reimage() Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
void	restart() Restarts the virtual machines in the scale set.
VirtualMachineScaleSetSkuTypes	sku()
void	start() Starts the virtual machines in the scale set.
VirtualMachineScaleSetStorageProfile	storageProfile()
UpgradeMode	upgradeModel()
List<String>	vhdContainers()

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource

resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

id, name, region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Wrapper

inner, setInner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Method Detail

listAvailableSkus

com.microsoft.azure.PagedList<VirtualMachineScaleSetSku> listAvailableSkus()
                                                                           throws com.microsoft.azure.CloudException,
                                                                                  IOException

Returns:

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

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

deallocate

void deallocate()
                throws com.microsoft.azure.CloudException,
                       IOException,
                       InterruptedException

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

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

powerOff

void powerOff()
              throws com.microsoft.azure.CloudException,
                     IOException,
                     InterruptedException

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

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

restart

void restart()
             throws com.microsoft.azure.CloudException,
                    IOException,
                    InterruptedException

Restarts the virtual machines in the scale set.

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

start

void start()
           throws com.microsoft.azure.CloudException,
                  IOException,
                  InterruptedException

Starts the virtual machines in the scale set.

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

reimage

void reimage()
             throws com.microsoft.azure.CloudException,
                    IOException,
                    InterruptedException

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

Throws:

com.microsoft.azure.CloudException - thrown for an invalid response from the service

IOException - exception thrown from serialization/deserialization

InterruptedException - exception thrown when the operation is interrupted

computerNamePrefix

String computerNamePrefix()

Returns:

the name prefix of the virtual machines in the scale set

osType

OperatingSystemTypes osType()

Returns:

the operating system of the virtual machines in the scale set

osDiskCachingType

CachingTypes osDiskCachingType()

Returns:

the operating system disk caching type

osDiskName

String osDiskName()

Returns:

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

upgradeModel

UpgradeMode upgradeModel()

Returns:

the upgradeModel

overProvisionEnabled

boolean overProvisionEnabled()

Returns:

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

sku

VirtualMachineScaleSetSkuTypes sku()

Returns:

the SKU of the virtual machines in the scale set

capacity

int capacity()

Returns:

the number of virtual machine instances in the scale set

getPrimaryNetwork

com.microsoft.azure.management.network.Network getPrimaryNetwork()
                                                                 throws IOException

Returns:

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

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

Throws:

IOException - the IO exception

getPrimaryInternetFacingLoadBalancer

com.microsoft.azure.management.network.LoadBalancer getPrimaryInternetFacingLoadBalancer()
                                                                                         throws IOException

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

listPrimaryInternetFacingLoadBalancerBackends

Map<String,com.microsoft.azure.management.network.Backend> listPrimaryInternetFacingLoadBalancerBackends()
                                                                                                         throws IOException

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

Map<String,com.microsoft.azure.management.network.InboundNatPool> listPrimaryInternetFacingLoadBalancerInboundNatPools()
                                                                                                                       throws IOException

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

getPrimaryInternalLoadBalancer

com.microsoft.azure.management.network.LoadBalancer getPrimaryInternalLoadBalancer()
                                                                                   throws IOException

Returns:

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

Throws:

IOException - the IO exception

listPrimaryInternalLoadBalancerBackends

Map<String,com.microsoft.azure.management.network.Backend> listPrimaryInternalLoadBalancerBackends()
                                                                                                   throws IOException

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

Map<String,com.microsoft.azure.management.network.InboundNatPool> listPrimaryInternalLoadBalancerInboundNatPools()
                                                                                                                 throws IOException

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

primaryPublicIpAddressIds

List<String> primaryPublicIpAddressIds()
                                       throws IOException

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

vhdContainers

List<String> vhdContainers()

Returns:

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

storageProfile

VirtualMachineScaleSetStorageProfile storageProfile()

Returns:

the storage profile

networkProfile

VirtualMachineScaleSetNetworkProfile networkProfile()

Returns:

the network profile

extensions

Map<String,VirtualMachineScaleSetExtension> extensions()

Returns:

the extensions attached to the virtual machines in the scale set