com.microsoft.azure.management.compute

Interface VirtualMachineScaleSet

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.compute.implementation.ComputeManager,com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetInner>, HasId, HasInner<com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetInner>, HasManager<com.microsoft.azure.management.compute.implementation.ComputeManager>, HasName, HasResourceGroup, Indexable, Refreshable<VirtualMachineScaleSet>, Resource, Updatable<VirtualMachineScaleSet.UpdateStages.WithPrimaryLoadBalancer>

public interface VirtualMachineScaleSet
extends GroupableResource<com.microsoft.azure.management.compute.implementation.ComputeManager,com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetInner>, Refreshable<VirtualMachineScaleSet>, 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.DefinitionManaged The entirety of the managed disk based virtual machine scale set definition.
static interface	VirtualMachineScaleSet.DefinitionManagedOrUnmanaged The entirety of the virtual machine scale set definition.
static interface	VirtualMachineScaleSet.DefinitionShared The virtual machine scale set stages shared between managed and unmanaged based virtual machine scale set definitions.
static interface	VirtualMachineScaleSet.DefinitionStages Grouping of virtual machine scale set definition stages.
static interface	VirtualMachineScaleSet.DefinitionUnmanaged The entirety of the unmanaged disk based virtual machine scale set definition.
static interface	VirtualMachineScaleSet.Update The entirety of the virtual machine scale set 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

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

Modifier and Type	Method and Description
AdditionalCapabilities	additionalCapabilities() Get specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set.
List<String>	applicationGatewayBackendAddressPoolsIds()
List<String>	applicationSecurityGroupIds()
Set<AvailabilityZoneId>	availabilityZones()
String	bootDiagnosticsStorageUri()
int	capacity()
String	computerNamePrefix()
void	deallocate() Shuts down the virtual machines in the scale set and releases its compute resources.
rx.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.
Boolean	doNotRunExtensionsOnOverprovisionedVMs()
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()
boolean	isAcceleratedNetworkingEnabled()
boolean	isBootDiagnosticsEnabled()
boolean	isIpForwardingEnabled()
boolean	isManagedDiskEnabled()
boolean	isManagedServiceIdentityEnabled()
boolean	isSinglePlacementGroupEnabled()
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()
StorageAccountTypes	managedOSDiskStorageAccountType()
ResourceIdentityType	managedServiceIdentityType()
VirtualMachineScaleSetNetworkProfile	networkProfile()
String	networkSecurityGroupId()
CachingTypes	osDiskCachingType()
String	osDiskName()
OperatingSystemTypes	osType()
boolean	overProvisionEnabled()
void	powerOff() Powers off (stops) the virtual machines in the scale set.
rx.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()
ProximityPlacementGroup	proximityPlacementGroup() Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
void	reimage() Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
rx.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.
rx.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.
RunCommandResult	runCommandInVMInstance(String vmId, RunCommandInput inputCommand) Run commands in a virtual machine instance in a scale set.
rx.Observable<RunCommandResult>	runCommandVMInstanceAsync(String vmId, RunCommandInput inputCommand) Run commands in a virtual machine instance in a scale set asynchronously.
RunCommandResult	runPowerShellScriptInVMInstance(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run PowerShell script in a virtual machine instance in a scale set.
rx.Observable<RunCommandResult>	runPowerShellScriptInVMInstanceAsync(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run PowerShell in a virtual machine instance in a scale set asynchronously.
RunCommandResult	runShellScriptInVMInstance(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine instance in a scale set.
rx.Observable<RunCommandResult>	runShellScriptInVMInstanceAsync(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine instance in a scale set asynchronously.
VirtualMachineScaleSetSkuTypes	sku()
void	start() Starts the virtual machines in the scale set.
rx.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()
String	systemAssignedManagedServiceIdentityPrincipalId()
String	systemAssignedManagedServiceIdentityTenantId()
UpgradeMode	upgradeModel()
Set<String>	userAssignedManagedServiceIdentityIds()
List<String>	vhdContainers()
VirtualMachineEvictionPolicyTypes	virtualMachineEvictionPolicy()
VirtualMachinePriorityTypes	virtualMachinePriority()
VirtualMachineScaleSetPublicIPAddressConfiguration	virtualMachinePublicIpConfig()
VirtualMachineScaleSetVMs	virtualMachines()

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

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.arm.models.HasId

id

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

name

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

resourceGroupName

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

manager

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

inner

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

refresh, refreshAsync

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

update

Method Detail

virtualMachines

VirtualMachineScaleSetVMs virtualMachines()

Returns:

entry point to manage virtual machine instances in the scale set.

listAvailableSkus

PagedList<VirtualMachineScaleSetSku> listAvailableSkus()

Returns:

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

deallocate

void deallocate()

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

deallocateAsync

rx.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

ServiceFuture<Void> deallocateAsync(ServiceCallback<Void> 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

powerOff

void powerOff()

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

powerOffAsync

rx.Completable powerOffAsync()

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

Returns:

a representation of the deferred computation of this call

powerOffAsync

ServiceFuture<Void> powerOffAsync(ServiceCallback<Void> 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

restart

void restart()

Restarts the virtual machines in the scale set.

restartAsync

rx.Completable restartAsync()

Restarts the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

restartAsync

ServiceFuture<Void> restartAsync(ServiceCallback<Void> 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

start

void start()

Starts the virtual machines in the scale set.

startAsync

rx.Completable startAsync()

Starts the virtual machines in the scale set asynchronously.

Returns:

a representation of the deferred computation of this call

startAsync

ServiceFuture<Void> startAsync(ServiceCallback<Void> 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

reimage

void reimage()

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

reimageAsync

rx.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

ServiceFuture<Void> reimageAsync(ServiceCallback<Void> 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

runPowerShellScriptInVMInstance

RunCommandResult runPowerShellScriptInVMInstance(String vmId,
                                                 List<String> scriptLines,
                                                 List<RunCommandInputParameter> scriptParameters)

Run PowerShell script in a virtual machine instance in a scale set.

Parameters:

vmId - the virtual machine instance id

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

result of PowerShell script execution

runPowerShellScriptInVMInstanceAsync

rx.Observable<RunCommandResult> runPowerShellScriptInVMInstanceAsync(String vmId,
                                                                     List<String> scriptLines,
                                                                     List<RunCommandInputParameter> scriptParameters)

Run PowerShell in a virtual machine instance in a scale set asynchronously.

Parameters:

vmId - the virtual machine instance id

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runShellScriptInVMInstance

RunCommandResult runShellScriptInVMInstance(String vmId,
                                            List<String> scriptLines,
                                            List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine instance in a scale set.

Parameters:

vmId - the virtual machine instance id

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

result of shell script execution

runShellScriptInVMInstanceAsync

rx.Observable<RunCommandResult> runShellScriptInVMInstanceAsync(String vmId,
                                                                List<String> scriptLines,
                                                                List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine instance in a scale set asynchronously.

Parameters:

vmId - the virtual machine instance id

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runCommandInVMInstance

RunCommandResult runCommandInVMInstance(String vmId,
                                        RunCommandInput inputCommand)

Run commands in a virtual machine instance in a scale set.

Parameters:

vmId - the virtual machine instance id

inputCommand - command input

Returns:

result of execution

runCommandVMInstanceAsync

rx.Observable<RunCommandResult> runCommandVMInstanceAsync(String vmId,
                                                          RunCommandInput inputCommand)

Run commands in a virtual machine instance in a scale set asynchronously.

Parameters:

vmId - the virtual machine instance id

inputCommand - command input

Returns:

handle to the asynchronous execution

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 upgrade model

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

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

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,LoadBalancerBackend> 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,LoadBalancerInboundNatPool> 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

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,LoadBalancerBackend> 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,LoadBalancerInboundNatPool> 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

virtualMachinePriority

@Beta(value=V1_8_0)
VirtualMachinePriorityTypes virtualMachinePriority()

Returns:

the priority of virtual machines in the scale set.

virtualMachineEvictionPolicy

@Beta(value=V1_11_0)
VirtualMachineEvictionPolicyTypes virtualMachineEvictionPolicy()

Returns:

the eviction policy of the virtual machines in the scale set.

getNetworkInterfaceByInstanceId

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

listNetworkInterfaces

PagedList<VirtualMachineScaleSetNetworkInterface> listNetworkInterfaces()

Returns:

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

listNetworkInterfacesByInstanceId

PagedList<VirtualMachineScaleSetNetworkInterface> 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

isManagedDiskEnabled

boolean isManagedDiskEnabled()

Returns:

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

isManagedServiceIdentityEnabled

@Beta(value=V1_2_0)
boolean isManagedServiceIdentityEnabled()

Returns:

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

systemAssignedManagedServiceIdentityTenantId

@Beta(value=V1_5_0)
String systemAssignedManagedServiceIdentityTenantId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine scale set.

systemAssignedManagedServiceIdentityPrincipalId

@Beta(value=V1_5_0)
String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine scale set.

managedServiceIdentityType

@Beta(value=V1_4_0)
ResourceIdentityType managedServiceIdentityType()

Returns:

the type of Managed Service Identity used for the virtual machine scale set.

userAssignedManagedServiceIdentityIds

@Beta(value=V1_5_1)
Set<String> userAssignedManagedServiceIdentityIds()

Returns:

the resource ids of User Assigned Managed Service Identities associated with the virtual machine scale set.

availabilityZones

@Beta(value=V1_3_0)
Set<AvailabilityZoneId> availabilityZones()

Returns:

the availability zones assigned to virtual machine scale set.

isBootDiagnosticsEnabled

@Beta(value=V1_4_0)
boolean isBootDiagnosticsEnabled()

Returns:

true if boot diagnostics is enabled for the virtual machine scale set.

bootDiagnosticsStorageUri

@Beta(value=V1_4_0)
String bootDiagnosticsStorageUri()

Returns:

the storage blob endpoint uri if boot diagnostics is enabled for the virtual machine scale set.

managedOSDiskStorageAccountType

@Beta(value=V1_4_0)
StorageAccountTypes managedOSDiskStorageAccountType()

Returns:

the storage account type of the OS managed disk. A null value will be returned if the virtual machine scale set is based on un-managed disk.

virtualMachinePublicIpConfig

@Beta(value=V1_14_0)
VirtualMachineScaleSetPublicIPAddressConfiguration virtualMachinePublicIpConfig()

Returns:

the public ip configuration of virtual machines in the scale set.

isIpForwardingEnabled

@Beta(value=V1_14_0)
boolean isIpForwardingEnabled()

Returns:

true if ip forwarding is enabled for the virtual machine scale set.

isAcceleratedNetworkingEnabled

@Beta(value=V1_14_0)
boolean isAcceleratedNetworkingEnabled()

Returns:

true if accelerated networking is enabled for the virtual machine scale set.

networkSecurityGroupId

@Beta(value=V1_14_0)
String networkSecurityGroupId()

Returns:

the network security group ARM id.

isSinglePlacementGroupEnabled

@Beta(value=V1_14_0)
boolean isSinglePlacementGroupEnabled()

Returns:

true if single placement group is enabled for the virtual machine scale set.

applicationGatewayBackendAddressPoolsIds

List<String> applicationGatewayBackendAddressPoolsIds()

Returns:

the list of application gateway backend pool associated with the virtual machine scale set.

applicationSecurityGroupIds

List<String> applicationSecurityGroupIds()

Returns:

the list of application security groups associated with the virtual machine scale set.

doNotRunExtensionsOnOverprovisionedVMs

Boolean doNotRunExtensionsOnOverprovisionedVMs()

Returns:

When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.

proximityPlacementGroup

ProximityPlacementGroup proximityPlacementGroup()

Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Returns:

the proximityPlacementGroup.

additionalCapabilities

AdditionalCapabilities additionalCapabilities()

Get specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

Returns:

the additionalCapabilities value