VirtualMachineScaleSet Interface
Implements
public interface VirtualMachineScaleSet
extends GroupableResource<ComputeManager,VirtualMachineScaleSetInner>, Refreshable<VirtualMachineScaleSet>, Updatable<WithPrimaryLoadBalancer>
An immutable client-side representation of an Azure virtual machine scale set.
Method Summary
Modifier and Type | Method and Description |
---|---|
abstract
Additional |
additionalCapabilities()
Get specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. |
abstract List<String> |
applicationGatewayBackendAddressPoolsIds()
Gets the list of application gateway backend pool associated with the virtual machine scale set. |
abstract List<String> |
applicationSecurityGroupIds()
Gets the list of application security groups associated with the virtual machine scale set. |
abstract
Set<Availability |
availabilityZones()
Gets the availability zones assigned to virtual machine scale set. |
abstract
Billing |
billingProfile()
Gets the billing related details of the low priority virtual machines in the scale set. |
abstract String |
bootDiagnosticsStorageUri()
Gets the storage blob endpoint uri. |
abstract int |
capacity()
Gets the number of virtual machine instances in the scale set. |
abstract String |
computerNamePrefix()
Gets the name prefix of the virtual machines in the scale set. |
abstract void |
deallocate()
Shuts down the virtual machines in the scale set and releases its compute resources. |
abstract Mono<Void> |
deallocateAsync()
Shuts down the virtual machines in the scale set and releases its compute resources asynchronously. |
abstract Boolean |
doNotRunExtensionsOnOverprovisionedVMs()
Checks whether Overprovision is enabled. |
abstract
Map<String,Virtual |
extensions()
Gets the extensions attached to the virtual machines in the scale set. |
abstract
Virtual |
getNetworkInterfaceByInstanceId(String instanceId, String name)
Gets a network interface associated with a virtual machine scale set instance. |
abstract
Mono<Virtual |
getNetworkInterfaceByInstanceIdAsync(String instanceId, String name)
Gets a network interface associated with a virtual machine scale set instance. |
abstract
Load |
getPrimaryInternalLoadBalancer()
Gets the internal load balancer associated with the primary network interface of the virtual machines in the scale set. |
abstract
Load |
getPrimaryInternetFacingLoadBalancer()
Gets the Internet-facing load balancer associated with the primary network interface of the virtual machines in the scale set. |
abstract Network |
getPrimaryNetwork()
Gets the virtual network associated with the primary network interfaces of the virtual machines in the scale set. |
abstract boolean |
isAcceleratedNetworkingEnabled()
Checks whether accelerated networking is enabled for the virtual machine scale set. |
abstract boolean |
isBootDiagnosticsEnabled()
Checks whether boot diagnostics is enabled for the virtual machine scale set. |
abstract boolean |
isEphemeralOSDisk()
Checks whether the instance OS disk is ephemeral. |
abstract boolean |
isIpForwardingEnabled()
Checks whether ip forwarding is enabled for the virtual machine scale set. |
abstract boolean |
isManagedDiskEnabled()
Checks whether managed disk is used for the virtual machine scale set's disks (os, data). |
abstract boolean |
isManagedServiceIdentityEnabled()
Checks whether Managed Service Identity is enabled for the virtual machine scale set. |
abstract boolean |
isSinglePlacementGroupEnabled()
Checks whether single placement group is enabled for the virtual machine scale set. |
abstract
Paged |
listAvailableSkus()
Gets available SKUs for the virtual machine scale set. |
abstract
Paged |
listNetworkInterfaces()
Gets the network interfaces associated with all virtual machine instances in a scale set. |
abstract
Paged |
listNetworkInterfacesByInstanceId(String virtualMachineInstanceId)
Lists the network interface associated with a specific virtual machine instance in the scale set. |
abstract
Paged |
listNetworkInterfacesByInstanceIdAsync(String virtualMachineInstanceId)
Lists the network interface associated with a specific virtual machine instance in the scale set asynchronously. |
abstract
Map<String,Load |
listPrimaryInternalLoadBalancerBackends()
Gets the internal load balancer's backends associated with the primary network interface of the virtual machines in the scale set. |
abstract
Map<String,Load |
listPrimaryInternalLoadBalancerInboundNatPools()
Gets the inbound NAT pools of the internal load balancer associated with the primary network interface of the virtual machines in the scale set. |
abstract
Map<String,Load |
listPrimaryInternetFacingLoadBalancerBackends()
Gets the Internet-facing load balancer's backends associated with the primary network interface of the virtual machines in the scale set. |
abstract
Map<String,Load |
listPrimaryInternetFacingLoadBalancerInboundNatPools()
Gets the Internet-facing load balancer's inbound NAT pool associated with the primary network interface of the virtual machines in the scale set. |
abstract
Storage |
managedOSDiskStorageAccountType()
Gets the storage account type of the OS managed disk. |
abstract
Resource |
managedServiceIdentityType()
Gets the type of Managed Service Identity used for the virtual machine scale set. |
abstract
Virtual |
networkProfile()
Gets the network profile. |
abstract String |
networkSecurityGroupId()
Gets the network security group ARM id. |
abstract
Orchestration |
orchestrationMode()
Get orchestration mode of the Virtual Machine Scale Set. |
abstract
Caching |
osDiskCachingType()
Gets the operating system disk caching type. |
abstract String |
osDiskName()
Gets the name of the OS disk of virtual machines in the scale set. |
abstract
Operating |
osType()
Gets the operating system of the virtual machines in the scale set. |
abstract boolean |
overProvisionEnabled()
Checks whether over provision is enabled for the virtual machines. |
abstract Plan |
plan()
Gets the purchase plan information about marketplace image. |
abstract void |
powerOff()
Powers off (stops) the virtual machines in the scale set. |
abstract Mono<Void> |
powerOffAsync()
Powers off (stops) the virtual machines in the scale set asynchronously. |
abstract List<String> |
primaryPublicIpAddressIds()
Gets the list of IDs of the public IP addresses associated with the primary Internet-facing load balancer of the scale set |
abstract
Proximity |
proximityPlacementGroup()
Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
abstract void |
reimage()
Re-images (updates the version of the installed operating system) the virtual machines in the scale set. |
abstract Mono<Void> |
reimageAsync()
Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously. |
abstract void |
restart()
Restarts the virtual machines in the scale set. |
abstract Mono<Void> |
restartAsync()
Restarts the virtual machines in the scale set asynchronously. |
abstract
Run |
runCommandInVMInstance(String vmId, RunCommandInput inputCommand)
Run commands in a virtual machine instance in a scale set. |
abstract
Mono<Run |
runCommandVMInstanceAsync(String vmId, RunCommandInput inputCommand)
Run commands in a virtual machine instance in a scale set asynchronously. |
abstract
Run |
runPowerShellScriptInVMInstance(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)
Run Power |
abstract
Mono<Run |
runPowerShellScriptInVMInstanceAsync(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)
Run Power |
abstract
Run |
runShellScriptInVMInstance(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)
Run shell script in a virtual machine instance in a scale set. |
abstract
Mono<Run |
runShellScriptInVMInstanceAsync(String vmId, List<String> scriptLines, List<RunCommandInputParameter> scriptParameters)
Run shell script in a virtual machine instance in a scale set asynchronously. |
abstract
Virtual |
sku()
Gets the SKU of the virtual machines in the scale set. |
abstract void |
start()
Starts the virtual machines in the scale set. |
abstract Mono<Void> |
startAsync()
Starts the virtual machines in the scale set asynchronously. |
abstract
Virtual |
storageProfile()
Gets the storage profile. |
abstract String |
systemAssignedManagedServiceIdentityPrincipalId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine scale set. |
abstract String |
systemAssignedManagedServiceIdentityTenantId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine scale set. |
abstract
Upgrade |
upgradeModel()
Gets the upgrade model, null for scale set with FLEXIBLE. |
abstract Set<String> |
userAssignedManagedServiceIdentityIds()
Gets the resource ids of User Assigned Managed Service Identities associated with the virtual machine scale set. |
abstract List<String> |
vhdContainers()
Gets the URL to storage containers that store the VHDs of the virtual machines in the scale set. |
abstract
Virtual |
virtualMachineEvictionPolicy()
Gets the eviction policy of the virtual machines in the scale set. |
abstract
Virtual |
virtualMachinePriority()
Gets the priority of virtual machines in the scale set. |
abstract
Virtual |
virtualMachinePublicIpConfig()
Gets the public ip configuration of virtual machines in the scale set. |
abstract
Virtual |
virtualMachines()
Gets entry point to manage virtual machine instances in the scale set.. |
Method Details
additionalCapabilities
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:
applicationGatewayBackendAddressPoolsIds
public abstract List
Gets the list of application gateway backend pool associated with the virtual machine scale set.
Returns:
applicationSecurityGroupIds
public abstract List
Gets the list of application security groups associated with the virtual machine scale set.
Returns:
availabilityZones
public abstract Set
Gets the availability zones assigned to virtual machine scale set.
Returns:
billingProfile
public abstract BillingProfile billingProfile()
Gets the billing related details of the low priority virtual machines in the scale set.
Returns:
bootDiagnosticsStorageUri
public abstract String bootDiagnosticsStorageUri()
Gets the storage blob endpoint uri.
Returns:
capacity
public abstract int capacity()
Gets the number of virtual machine instances in the scale set.
Returns:
computerNamePrefix
public abstract String computerNamePrefix()
Gets the name prefix of the virtual machines in the scale set.
Returns:
deallocate
public abstract void deallocate()
Shuts down the virtual machines in the scale set and releases its compute resources.
deallocateAsync
public abstract Mono
Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.
Returns:
doNotRunExtensionsOnOverprovisionedVMs
public abstract Boolean doNotRunExtensionsOnOverprovisionedVMs()
Checks whether Overprovision is enabled.
Returns:
extensions
public abstract Map
Gets the extensions attached to the virtual machines in the scale set.
Returns:
getNetworkInterfaceByInstanceId
public abstract VirtualMachineScaleSetNetworkInterface getNetworkInterfaceByInstanceId(String instanceId, String name)
Gets a network interface associated with a virtual machine scale set instance.
Parameters:
Returns:
getNetworkInterfaceByInstanceIdAsync
public abstract Mono
Gets a network interface associated with a virtual machine scale set instance.
Parameters:
Returns:
getPrimaryInternalLoadBalancer
public abstract LoadBalancer getPrimaryInternalLoadBalancer()
Gets the internal load balancer associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
getPrimaryInternetFacingLoadBalancer
public abstract LoadBalancer getPrimaryInternetFacingLoadBalancer()
Gets the Internet-facing load balancer associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
getPrimaryNetwork
public abstract Network getPrimaryNetwork()
Gets the virtual network associated with the primary network interfaces of the virtual machines in the scale set.
Returns:
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:
isAcceleratedNetworkingEnabled
public abstract boolean isAcceleratedNetworkingEnabled()
Checks whether accelerated networking is enabled for the virtual machine scale set.
Returns:
isBootDiagnosticsEnabled
public abstract boolean isBootDiagnosticsEnabled()
Checks whether boot diagnostics is enabled for the virtual machine scale set.
Returns:
isEphemeralOSDisk
public abstract boolean isEphemeralOSDisk()
Checks whether the instance OS disk is ephemeral.
Returns:
isIpForwardingEnabled
public abstract boolean isIpForwardingEnabled()
Checks whether ip forwarding is enabled for the virtual machine scale set.
Returns:
isManagedDiskEnabled
public abstract boolean isManagedDiskEnabled()
Checks whether managed disk is used for the virtual machine scale set's disks (os, data).
Returns:
isManagedServiceIdentityEnabled
public abstract boolean isManagedServiceIdentityEnabled()
Checks whether Managed Service Identity is enabled for the virtual machine scale set.
Returns:
isSinglePlacementGroupEnabled
public abstract boolean isSinglePlacementGroupEnabled()
Checks whether single placement group is enabled for the virtual machine scale set.
Returns:
listAvailableSkus
public abstract PagedIterable
Gets available SKUs for the virtual machine scale set.
Returns:
listNetworkInterfaces
public abstract PagedIterable
Gets the network interfaces associated with all virtual machine instances in a scale set.
Returns:
listNetworkInterfacesByInstanceId
public abstract PagedIterable
Lists the network interface associated with a specific virtual machine instance in the scale set.
Parameters:
Returns:
listNetworkInterfacesByInstanceIdAsync
public abstract PagedFlux
Lists the network interface associated with a specific virtual machine instance in the scale set asynchronously.
Parameters:
Returns:
listPrimaryInternalLoadBalancerBackends
public abstract Map
Gets the internal load balancer's backends associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
listPrimaryInternalLoadBalancerInboundNatPools
public abstract Map
Gets the inbound NAT pools of the internal load balancer associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
listPrimaryInternetFacingLoadBalancerBackends
public abstract Map
Gets the Internet-facing load balancer's backends associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
listPrimaryInternetFacingLoadBalancerInboundNatPools
public abstract Map
Gets the Internet-facing load balancer's inbound NAT pool associated with the primary network interface of the virtual machines in the scale set.
Returns:
Throws:
managedOSDiskStorageAccountType
public abstract StorageAccountTypes managedOSDiskStorageAccountType()
Gets the storage account type of the OS managed disk.
Returns:
managedServiceIdentityType
public abstract ResourceIdentityType managedServiceIdentityType()
Gets the type of Managed Service Identity used for the virtual machine scale set.
Returns:
networkProfile
public abstract VirtualMachineScaleSetNetworkProfile networkProfile()
Gets the network profile.
Returns:
networkSecurityGroupId
public abstract String networkSecurityGroupId()
Gets the network security group ARM id.
Returns:
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:
osDiskCachingType
public abstract CachingTypes osDiskCachingType()
Gets the operating system disk caching type.
Returns:
osDiskName
public abstract String osDiskName()
Gets the name of the OS disk of virtual machines in the scale set.
Returns:
osType
public abstract OperatingSystemTypes osType()
Gets the operating system of the virtual machines in the scale set.
Returns:
overProvisionEnabled
public abstract boolean overProvisionEnabled()
Checks whether over provision is enabled for the virtual machines.
Returns:
plan
public abstract Plan plan()
Gets the purchase plan information about marketplace image.
Returns:
powerOff
public abstract void powerOff()
Powers off (stops) the virtual machines in the scale set.
powerOffAsync
public abstract Mono
Powers off (stops) the virtual machines in the scale set asynchronously.
Returns:
primaryPublicIpAddressIds
public abstract List
Gets the list of IDs of the public IP addresses associated with the primary Internet-facing load balancer of the scale set
Returns:
Throws:
proximityPlacementGroup
public abstract ProximityPlacementGroup proximityPlacementGroup()
Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Returns:
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
Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
Returns:
restart
public abstract void restart()
Restarts the virtual machines in the scale set.
restartAsync
public abstract Mono
Restarts the virtual machines in the scale set asynchronously.
Returns:
runCommandInVMInstance
public abstract RunCommandResult runCommandInVMInstance(String vmId, RunCommandInput inputCommand)
Run commands in a virtual machine instance in a scale set.
Parameters:
Returns:
runCommandVMInstanceAsync
public abstract Mono
Run commands in a virtual machine instance in a scale set asynchronously.
Parameters:
Returns:
runPowerShellScriptInVMInstance
public abstract RunCommandResult runPowerShellScriptInVMInstance(String vmId, List
Run PowerShell script in a virtual machine instance in a scale set.
Parameters:
Returns:
runPowerShellScriptInVMInstanceAsync
public abstract Mono
Run PowerShell in a virtual machine instance in a scale set asynchronously.
Parameters:
Returns:
runShellScriptInVMInstance
public abstract RunCommandResult runShellScriptInVMInstance(String vmId, List
Run shell script in a virtual machine instance in a scale set.
Parameters:
Returns:
runShellScriptInVMInstanceAsync
public abstract Mono
Run shell script in a virtual machine instance in a scale set asynchronously.
Parameters:
Returns:
sku
public abstract VirtualMachineScaleSetSkuTypes sku()
Gets the SKU of the virtual machines in the scale set.
Returns:
start
public abstract void start()
Starts the virtual machines in the scale set.
startAsync
public abstract Mono
Starts the virtual machines in the scale set asynchronously.
Returns:
storageProfile
public abstract VirtualMachineScaleSetStorageProfile storageProfile()
Gets the storage profile.
Returns:
systemAssignedManagedServiceIdentityPrincipalId
public abstract String systemAssignedManagedServiceIdentityPrincipalId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine scale set.
Returns:
systemAssignedManagedServiceIdentityTenantId
public abstract String systemAssignedManagedServiceIdentityTenantId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine scale set.
Returns:
upgradeModel
userAssignedManagedServiceIdentityIds
public abstract Set
Gets the resource ids of User Assigned Managed Service Identities associated with the virtual machine scale set.
Returns:
vhdContainers
public abstract List
Gets the URL to storage containers that store the VHDs of the virtual machines in the scale set.
Returns:
virtualMachineEvictionPolicy
public abstract VirtualMachineEvictionPolicyTypes virtualMachineEvictionPolicy()
Gets the eviction policy of the virtual machines in the scale set.
Returns:
virtualMachinePriority
public abstract VirtualMachinePriorityTypes virtualMachinePriority()
Gets the priority of virtual machines in the scale set.
Returns:
virtualMachinePublicIpConfig
public abstract VirtualMachineScaleSetPublicIpAddressConfiguration virtualMachinePublicIpConfig()
Gets the public ip configuration of virtual machines in the scale set.
Returns:
virtualMachines
public abstract VirtualMachineScaleSetVMs virtualMachines()
Gets entry point to manage virtual machine instances in the scale set..
Returns: