public abstract 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
applicationGatewayBackendAddressPoolsIds
public abstract List applicationGatewayBackendAddressPoolsIds()
Returns:
the list of application gateway backend pool associated with the virtual machine scale set.
applicationSecurityGroupIds
public abstract List applicationSecurityGroupIds()
Returns:
the list of application security groups associated with the virtual machine scale set.
availabilityZones
public abstract Set availabilityZones()
Returns:
the availability zones assigned to virtual machine scale set.
billingProfile
public abstract BillingProfile billingProfile()
Returns:
the billing related details of the low priority virtual machines in the scale set.
bootDiagnosticsStorageUri
public abstract String bootDiagnosticsStorageUri()
Returns:
the storage blob endpoint uri if boot diagnostics is enabled for the virtual machine scale set.
capacity
public abstract int capacity()
Returns:
the number of virtual machine instances in the scale set
computerNamePrefix
public abstract String computerNamePrefix()
Returns:
the name prefix of the virtual machines in the scale set
deallocate
public abstract void deallocate()
Shuts down the virtual machines in the scale set and releases its compute resources.
deallocateAsync
public abstract Mono 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
doNotRunExtensionsOnOverprovisionedVMs
public abstract 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.
extensions
public abstract Map extensions()
Returns:
the extensions attached to the virtual machines in the scale set
getNetworkInterfaceByInstanceId
public abstract 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
getNetworkInterfaceByInstanceIdAsync
public abstract Mono getNetworkInterfaceByInstanceIdAsync(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 abstract LoadBalancer getPrimaryInternalLoadBalancer()
Returns:
the internal load balancer associated with the primary network interface of the virtual machines in the
scale set
public abstract 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.
managedServiceIdentityType
public abstract ResourceIdentityType managedServiceIdentityType()
Returns:
the type of Managed Service Identity used for the virtual machine scale set.
networkProfile
public abstract VirtualMachineScaleSetNetworkProfile networkProfile()
Returns:
the network profile
networkSecurityGroupId
public abstract String networkSecurityGroupId()
Returns:
the network security group ARM id.
orchestrationMode
public abstract OrchestrationMode orchestrationMode()
Get orchestration mode of the Virtual Machine Scale Set. Scale set orchestration modes allow you to have greater control over how virtual machine instances are managed by the scale set.
Returns:
the orchestration mode of the virtual machine scale set
osDiskCachingType
public abstract CachingTypes osDiskCachingType()
Returns:
the operating system disk caching type
osDiskName
public abstract String osDiskName()
Returns:
the name of the OS disk of virtual machines in the scale set
osType
public abstract OperatingSystemTypes osType()
Returns:
the operating system of the virtual machines in the scale set
overProvisionEnabled
public abstract boolean overProvisionEnabled()
Returns:
true if over provision is enabled for the virtual machines, false otherwise
plan
public abstract Plan plan()
Returns:
the purchase plan information about marketplace image
powerOff
public abstract void powerOff()
Powers off (stops) the virtual machines in the scale set.
powerOffAsync
public abstract Mono powerOffAsync()
Powers off (stops) the virtual machines in the scale set asynchronously.
Returns:
a representation of the deferred computation of this call
primaryPublicIpAddressIds
public abstract List primaryPublicIpAddressIds()
Returns:
the list of IDs of the public IP addresses associated with the primary Internet-facing load balancer of
the scale set
public abstract ProximityPlacementGroup proximityPlacementGroup()
Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Returns:
the proximityPlacementGroup.
reimage
public abstract void reimage()
Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
reimageAsync
public abstract Mono 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
restart
public abstract void restart()
Restarts the virtual machines in the scale set.
restartAsync
public abstract Mono restartAsync()
Restarts the virtual machines in the scale set asynchronously.
Returns:
a representation of the deferred computation of this call
runCommandInVMInstance
public abstract 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
public abstract Mono 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
runPowerShellScriptInVMInstance
public abstract RunCommandResult runPowerShellScriptInVMInstance(String vmId, List scriptLines, List 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
public abstract Mono runPowerShellScriptInVMInstanceAsync(String vmId, List scriptLines, List 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
public abstract RunCommandResult runShellScriptInVMInstance(String vmId, List scriptLines, List 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
public abstract Mono runShellScriptInVMInstanceAsync(String vmId, List scriptLines, List 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
sku
public abstract VirtualMachineScaleSetSkuTypes sku()
Returns:
the SKU of the virtual machines in the scale set
start
public abstract void start()
Starts the virtual machines in the scale set.
startAsync
public abstract Mono startAsync()
Starts the virtual machines in the scale set asynchronously.
Returns:
a representation of the deferred computation of this call
storageProfile
public abstract VirtualMachineScaleSetStorageProfile storageProfile()
Returns:
the storage profile
systemAssignedManagedServiceIdentityPrincipalId
public abstract String systemAssignedManagedServiceIdentityPrincipalId()
Returns:
the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID
assigned to the virtual machine scale set.
systemAssignedManagedServiceIdentityTenantId
public abstract String systemAssignedManagedServiceIdentityTenantId()
Returns:
the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the
virtual machine scale set.
upgradeModel
public abstract UpgradeMode upgradeModel()
Returns:
the upgrade model, null for scale set with FLEXIBLE
userAssignedManagedServiceIdentityIds
public abstract Set userAssignedManagedServiceIdentityIds()
Returns:
the resource ids of User Assigned Managed Service Identities associated with the virtual machine scale
set.
vhdContainers
public abstract List vhdContainers()
Returns:
the URL to storage containers that store the VHDs of the virtual machines in the scale set
virtualMachineEvictionPolicy
public abstract VirtualMachineEvictionPolicyTypes virtualMachineEvictionPolicy()
Returns:
the eviction policy of the virtual machines in the scale set.
virtualMachinePriority
public abstract VirtualMachinePriorityTypes virtualMachinePriority()
Returns:
the priority of virtual machines in the scale set.
virtualMachinePublicIpConfig
public abstract VirtualMachineScaleSetPublicIpAddressConfiguration virtualMachinePublicIpConfig()
Returns:
the public ip configuration of virtual machines in the scale set.
virtualMachines
public abstract VirtualMachineScaleSetVMs virtualMachines()
Returns:
entry point to manage virtual machine instances in the scale set.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
