IVirtualMachineScaleSet Interface

Definition

Namespace:

Microsoft.Azure.Management.Compute.Fluent

Assembly:

Microsoft.Azure.Management.Compute.Fluent.dll

Package:

Microsoft.Azure.Management.Compute.Fluent v1.38.1

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

public interface IVirtualMachineScaleSet : Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSetBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.Compute.Fluent.IComputeManager,Microsoft.Azure.Management.Compute.Fluent.Models.VirtualMachineScaleSetInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.Compute.Fluent.Models.VirtualMachineScaleSetInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.Compute.Fluent.IComputeManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSet>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Update.IWithPrimaryLoadBalancer>

type IVirtualMachineScaleSet = interface
    interface IGroupableResource<IComputeManager, VirtualMachineScaleSetInner>
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IHasResourceGroup
    interface IHasManager<IComputeManager>
    interface IHasInner<VirtualMachineScaleSetInner>
    interface IRefreshable<IVirtualMachineScaleSet>
    interface IUpdatable<IWithPrimaryLoadBalancer>
    interface IVirtualMachineScaleSetBeta
    interface IBeta

Public Interface IVirtualMachineScaleSet
Implements IBeta, IGroupableResource(Of IComputeManager, VirtualMachineScaleSetInner), IHasInner(Of VirtualMachineScaleSetInner), IHasManager(Of IComputeManager), IRefreshable(Of IVirtualMachineScaleSet), IUpdatable(Of IWithPrimaryLoadBalancer), IVirtualMachineScaleSetBeta

Implements

IVirtualMachineScaleSetBeta IBeta IGroupableResource<IComputeManager,VirtualMachineScaleSetInner> IHasId IHasInner<InnerT> IHasInner<VirtualMachineScaleSetInner> IHasManager<ManagerT> IHasManager<IComputeManager> IHasName IHasResourceGroup IResource IIndexable IRefreshable<IVirtualMachineScaleSet> IUpdatable<IWithPrimaryLoadBalancer>

Properties

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.
ApplicationGatewayBackendAddressPoolsIds	Gets the list of application gateway backend pool associated with the virtual machine scale set.
ApplicationSecurityGroupIds	Gets the list of application security groups associated with the virtual machine scale set.
AvailabilityZones	Gets the availability zones assigned to virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
BillingProfile	Gets the billing related details of the low priority virtual machines in the scale set. (Inherited from IVirtualMachineScaleSetBeta)
BootDiagnosticsStorageUri	Gets the storage blob endpoint uri if boot diagnostics is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
Capacity	Gets the number of virtual machine instances in the scale set.
ComputerNamePrefix	Gets the name prefix of the virtual machines in the scale set.
DoNotRunExtensionsOnOverprovisionedVMs	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	Gets the extensions attached to the virtual machines in the scale set.
Id	Gets the resource id string (Inherited from IHasId)
Inner	(Inherited from IHasInner<T>)
IsAcceleratedNetworkingEnabled	Gets true if accelerated networking is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
IsBootDiagnosticsEnabled	Gets true if boot diagnostics is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
IsIpForwardingEnabled	Gets true if ip forwarding is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
IsManagedDiskEnabled	Gets true if managed disk is used for the virtual machine scale set's disks (os, data).
IsManagedServiceIdentityEnabled	Gets true if Managed Service Identity is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
IsSinglePlacementGroupEnabled	Gets true if single placement group is enabled for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
Key	(Inherited from IIndexable)
ManagedOSDiskStorageAccountType	Gets 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. (Inherited from IVirtualMachineScaleSetBeta)
ManagedServiceIdentityType	Gets the type of Managed Service Identity used for the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
Manager	Gets the manager client type of this resource type. (Inherited from IHasManager<ManagerT>)
Name	Gets the name of the resource (Inherited from IHasName)
NetworkProfile	Gets the network profile.
NetworkSecurityGroupId	Gets the network security group ARM id. (Inherited from IVirtualMachineScaleSetBeta)
OSDiskCachingType	Gets the operating system disk caching type.
OSDiskName	Gets the name of the OS disk of virtual machines in the scale set.
OSType	Gets the operating system of the virtual machines in the scale set.
OverProvisionEnabled	Gets true if over provision is enabled for the virtual machines, false otherwise.
PrimaryPublicIPAddressIds	Gets IOException the IO exception.
ProximityPlacementGroup	Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Region	(Inherited from IResource)
RegionName	(Inherited from IResource)
ResourceGroupName	(Inherited from IHasResourceGroup)
Sku	Gets the SKU of the virtual machines in the scale set.
StorageProfile	Gets the storage profile.
SystemAssignedManagedServiceIdentityPrincipalId	Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
SystemAssignedManagedServiceIdentityTenantId	Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
Tags	(Inherited from IResource)
Type	(Inherited from IResource)
UpgradeMode	Gets the upgrade mode.
UpgradeModel	Gets the upgrade mode.
UserAssignedManagedServiceIdentityIds	Gets the resource ids of User Assigned Managed Service Identities associated with the virtual machine scale set. (Inherited from IVirtualMachineScaleSetBeta)
VhdContainers	Gets the URL to storage containers that store the VHDs of the virtual machines in the scale set.
VirtualMachineEvictionPolicy	Gets the eviction policy of the virtual machines in the scale set. (Inherited from IVirtualMachineScaleSetBeta)
VirtualMachinePriority	Gets the priority of virtual machines in the scale set. (Inherited from IVirtualMachineScaleSetBeta)
VirtualMachinePublicIpConfig	Gets the public ip configuration of virtual machines in the scale set. (Inherited from IVirtualMachineScaleSetBeta)
VirtualMachines	Gets entry point to manage virtual machine instances in the scale set.

Methods

Deallocate()	Shuts down the virtual machines in the scale set and releases its compute resources.
DeallocateAsync(CancellationToken)	Shuts down the virtual machines in the scale set and releases its compute resources asynchronously.
GetNetworkInterfaceByInstanceId(String, String)	Gets a network interface associated with a virtual machine scale set instance.
GetPrimaryInternalLoadBalancer()
GetPrimaryInternetFacingLoadBalancer()
GetPrimaryNetwork()
ListAvailableSkus()
ListNetworkInterfaces()
ListNetworkInterfacesByInstanceId(String)	Lists the network interface associated with a specific virtual machine instance in the scale set.
ListPrimaryInternalLoadBalancerBackends()
ListPrimaryInternalLoadBalancerInboundNatPools()
ListPrimaryInternetFacingLoadBalancerBackends()
ListPrimaryInternetFacingLoadBalancerInboundNatPools()
PowerOff()	Powers off (stops) the virtual machines in the scale set.
PowerOffAsync(CancellationToken)	Powers off (stops) the virtual machines in the scale set asynchronously.
Refresh()	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
Reimage()	Re-images (updates the version of the installed operating system) the virtual machines in the scale set.
ReimageAsync(CancellationToken)	Re-images (updates the version of the installed operating system) the virtual machines in the scale set asynchronously.
Restart()	Restarts the virtual machines in the scale set.
RestartAsync(CancellationToken)	Restarts the virtual machines in the scale set asynchronously.
RunCommandInVMInstance(String, RunCommandInput)	Run commands in a virtual machine instance in a scale set. (Inherited from IVirtualMachineScaleSetBeta)
RunCommandVMInstanceAsync(String, RunCommandInput, CancellationToken)	Run commands in a virtual machine instance in a scale set asynchronously. (Inherited from IVirtualMachineScaleSetBeta)
RunPowerShellScriptInVMInstance(String, IList<String>, IList<RunCommandInputParameter>)	Run PowerShell script in a virtual machine instance in a scale set. (Inherited from IVirtualMachineScaleSetBeta)
RunPowerShellScriptInVMInstanceAsync(String, IList<String>, IList<RunCommandInputParameter>, CancellationToken)	Run PowerShell in a virtual machine instance in a scale set asynchronously. (Inherited from IVirtualMachineScaleSetBeta)
RunShellScriptInVMInstance(String, IList<String>, IList<RunCommandInputParameter>)	Run shell script in a virtual machine instance in a scale set. (Inherited from IVirtualMachineScaleSetBeta)
RunShellScriptInVMInstanceAsync(String, IList<String>, IList<RunCommandInputParameter>, CancellationToken)	Run shell script in a virtual machine instance in a scale set asynchronously. (Inherited from IVirtualMachineScaleSetBeta)
Start()	Starts the virtual machines in the scale set.
StartAsync(CancellationToken)	Starts the virtual machines in the scale set asynchronously.
Update()	(Inherited from IUpdatable<T>)