IDefinitionShared Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The virtual machine scale set stages shared between managed and unmanaged based virtual machine scale set definitions.
public interface IDefinitionShared : Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IBlank, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithCreate, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithGroup, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithInternalLoadBalancerBackendOrNatPool, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithPrimaryInternetFacingLoadBalancer, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithPrimaryInternetFacingLoadBalancerBackendOrNatPool, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithProximityPlacementGroup, Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithSku, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithCreatableResourceGroup<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithSku>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithExistingResourceGroup<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithSku>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithGroup<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithSku>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithNewResourceGroup<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithSku>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.Resource.Definition.IDefinitionWithRegion<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithGroup>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.Resource.Definition.IDefinitionWithTags<Microsoft.Azure.Management.Compute.Fluent.VirtualMachineScaleSet.Definition.IWithCreate>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.ICreatable<Microsoft.Azure.Management.Compute.Fluent.IVirtualMachineScaleSet>type IDefinitionShared = interface
interface IBlank
interface IDefinitionWithRegion<IWithGroup>
interface IWithGroup
interface IWithGroup<IWithSku>
interface IWithExistingResourceGroup<IWithSku>
interface IWithNewResourceGroup<IWithSku>
interface IWithCreatableResourceGroup<IWithSku>
interface IWithSku
interface IWithProximityPlacementGroup
interface IWithDoNotRunExtensionsOnOverprovisionedVms
interface IWithAdditionalCapabilities
interface IWithNetworkSubnet
interface IWithPrimaryInternetFacingLoadBalancer
interface IWithPrimaryInternalLoadBalancer
interface IWithPrimaryInternetFacingLoadBalancerBackendOrNatPool
interface IWithPrimaryInternetFacingLoadBalancerNatPool
interface IWithInternalLoadBalancerBackendOrNatPool
interface IWithInternalInternalLoadBalancerNatPool
interface IWithOS
interface IWithOSBeta
interface IBeta
interface IWithCreate
interface ICreatable<IVirtualMachineScaleSet>
interface IIndexable
interface IWithOSDiskSettings
interface IWithComputerNamePrefix
interface IWithCapacity
interface IWithUpgradePolicy
interface IWithOverProvision
interface IWithStorageAccount
interface IWithCustomData
interface IWithExtension
interface IWithSystemAssignedManagedServiceIdentity
interface IWithUserAssignedManagedServiceIdentity
interface IWithBootDiagnostics
interface IWithBillingProfile
interface IWithVMPriority
interface IWithVirtualMachinePublicIp
interface IWithAcceleratedNetworking
interface IWithIpForwarding
interface IWithNetworkSecurityGroup
interface IWithSinglePlacementGroup
interface IWithApplicationGateway
interface IWithApplicationSecurityGroup
interface IDefinitionWithTags<IWithCreate>Public Interface IDefinitionShared
Implements IBeta, IBlank, ICreatable(Of IVirtualMachineScaleSet), IDefinitionWithRegion(Of IWithGroup), IDefinitionWithTags(Of IWithCreate), IWithCreatableResourceGroup(Of IWithSku), IWithCreate, IWithExistingResourceGroup(Of IWithSku), IWithGroup, IWithGroup(Of IWithSku), IWithInternalLoadBalancerBackendOrNatPool, IWithNewResourceGroup(Of IWithSku), IWithPrimaryInternetFacingLoadBalancer, IWithPrimaryInternetFacingLoadBalancerBackendOrNatPool, IWithProximityPlacementGroup, IWithSku- Derived
- Implements
-
IBlank IWithAcceleratedNetworking IWithAdditionalCapabilities IWithApplicationGateway IWithApplicationSecurityGroup IWithBillingProfile IWithBootDiagnostics IWithCapacity IWithComputerNamePrefix IWithCreate IWithCustomData IWithDoNotRunExtensionsOnOverprovisionedVms IWithExtension IWithGroup IWithInternalInternalLoadBalancerNatPool IWithInternalLoadBalancerBackendOrNatPool IWithIpForwarding IWithNetworkSecurityGroup IWithNetworkSubnet IWithOS IWithOSBeta IWithOSDiskSettings IWithOverProvision IWithPrimaryInternalLoadBalancer IWithPrimaryInternetFacingLoadBalancer IWithPrimaryInternetFacingLoadBalancerBackendOrNatPool IWithPrimaryInternetFacingLoadBalancerNatPool IWithProximityPlacementGroup IWithSinglePlacementGroup IWithSku IWithStorageAccount IWithSystemAssignedManagedServiceIdentity IWithUpgradePolicy IWithUserAssignedManagedServiceIdentity IWithVirtualMachinePublicIp IWithVMPriority IWithCreatableResourceGroup<IWithSku> IWithCreatableResourceGroup<T> IWithExistingResourceGroup<IWithSku> IWithExistingResourceGroup<T> IWithGroup<IWithSku> IWithNewResourceGroup<IWithSku> IWithNewResourceGroup<T> IBeta IDefinitionWithRegion<IWithGroup> IDefinitionWithTags<IWithCreate> ICreatable<IVirtualMachineScaleSet> IIndexable
Properties
| Key | (Inherited from IIndexable) |
| Name |
Gets the name of the creatable resource. (Inherited from ICreatable<T>) |
Methods
| Create() |
Execute the create request. (Inherited from ICreatable<T>) |
| CreateAsync(CancellationToken, Boolean) |
Puts the request into the queue and allow the HTTP client to execute it when system resources are available. (Inherited from ICreatable<T>) |
| DefineNewExtension(String) |
Begins the definition of an extension reference to be attached to the virtual machines in the scale set. (Inherited from IWithExtension) |
| WithAcceleratedNetworking() |
Specify that accelerated networking should be enabled for the virtual machine scale set. (Inherited from IWithAcceleratedNetworking) |
| WithAdditionalCapabilities(AdditionalCapabilities) |
Set 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. (Inherited from IWithAdditionalCapabilities) |
| WithBootDiagnostics() |
Specifies that boot diagnostics needs to be enabled in the virtual machine scale set. (Inherited from IWithBootDiagnostics) |
| WithBootDiagnostics(ICreatable<IStorageAccount>) |
Specifies that boot diagnostics needs to be enabled in the virtual machine scale set. (Inherited from IWithBootDiagnostics) |
| WithBootDiagnostics(IStorageAccount) |
Specifies that boot diagnostics needs to be enabled in the virtual machine scale set. (Inherited from IWithBootDiagnostics) |
| WithBootDiagnostics(String) |
Specifies that boot diagnostics needs to be enabled in the virtual machine scale set. (Inherited from IWithBootDiagnostics) |
| WithCapacity(Int32) |
Specifies the maximum number of virtual machines in the scale set. (Inherited from IWithCapacity) |
| WithComputerNamePrefix(String) |
Specifies the name prefix to use for auto-generating the names for the virtual machines in the scale set. (Inherited from IWithComputerNamePrefix) |
| WithCustomData(String) |
Specifies the custom data for the virtual machine scale set. (Inherited from IWithCustomData) |
| WithDoNotRunExtensionsOnOverprovisionedVMs(Boolean) |
Set 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. (Inherited from IWithDoNotRunExtensionsOnOverprovisionedVms) |
| WithExistingApplicationGatewayBackendPool(String) |
Specify that an application gateway backend pool should be associated with virtual machine scale set. (Inherited from IWithApplicationGateway) |
| WithExistingApplicationSecurityGroup(IApplicationSecurityGroup) |
Specifies that provided application security group should be associated with the virtual machine scale set. (Inherited from IWithApplicationSecurityGroup) |
| WithExistingApplicationSecurityGroupId(String) |
Specifies that provided application security group should be associated with the virtual machine scale set. (Inherited from IWithApplicationSecurityGroup) |
| WithExistingNetworkSecurityGroup(INetworkSecurityGroup) |
Specifies the network security group for the virtual machine scale set. (Inherited from IWithNetworkSecurityGroup) |
| WithExistingNetworkSecurityGroupId(String) |
Specifies the network security group for the virtual machine scale set. (Inherited from IWithNetworkSecurityGroup) |
| WithExistingPrimaryInternalLoadBalancer(ILoadBalancer) |
Specifies the internal load balancer whose backends and/or NAT pools can be assigned to the primary network interface of the virtual machines in the scale set. By default all the backends and inbound NAT pools of the load balancer will be associated with the primary network interface of the virtual machines in the scale set, unless subset of them is selected in the next stages. (Inherited from IWithPrimaryInternalLoadBalancer) |
| WithExistingPrimaryInternetFacingLoadBalancer(ILoadBalancer) |
Specifies an Internet-facing load balancer whose backends and/or NAT pools can be assigned to the primary network interfaces of the virtual machines in the scale set. By default, all the backends and inbound NAT pools of the load balancer will be associated with the primary network interface of the scale set virtual machines. (Inherited from IWithPrimaryInternetFacingLoadBalancer) |
| WithExistingPrimaryNetworkSubnet(INetwork, String) |
Associate an existing virtual network subnet with the primary network interface of the virtual machines in the scale set. (Inherited from IWithNetworkSubnet) |
| WithExistingResourceGroup(IResourceGroup) |
Associates the resource with an existing resource group. (Inherited from IWithExistingResourceGroup<T>) |
| WithExistingResourceGroup(String) |
Associates the resource with an existing resource group. (Inherited from IWithExistingResourceGroup<T>) |
| WithExistingStorageAccount(IStorageAccount) |
Specifies an existing storage account for the OS and data disk VHDs of the virtual machines in the scale set. (Inherited from IWithStorageAccount) |
| WithExistingUserAssignedManagedServiceIdentity(IIdentity) |
Specifies an existing user assigned identity to be associated with the virtual machine scale set. (Inherited from IWithUserAssignedManagedServiceIdentity) |
| WithIpForwarding() |
Specify that ip forwarding should be enabled for the virtual machine scale set. (Inherited from IWithIpForwarding) |
| WithLatestLinuxImage(String, String, String) |
Specifies that the latest version of a marketplace Linux image should be used. (Inherited from IWithOS) |
| WithLatestWindowsImage(String, String, String) |
Specifies that the latest version of the specified marketplace Windows image should be used. (Inherited from IWithOS) |
| WithLinuxCustomImage(String) |
Specifies the ID of a Linux custom image to be used. (Inherited from IWithOS) |
| WithLinuxGalleryImageVersion(String) |
Specifies the resource ID of a Linux gallery image version to be used as the virtual machines scaleset OS. (Inherited from IWithOSBeta) |
| WithLowPriorityVirtualMachine() |
Specify that virtual machines in the scale set should be low priority VMs. (Inherited from IWithVMPriority) |
| WithLowPriorityVirtualMachine(VirtualMachineEvictionPolicyTypes) |
Specify that virtual machines in the scale set should be low priority VMs with provided eviction policy. (Inherited from IWithVMPriority) |
| WithMaxPrice(Nullable<Double>) |
Specifies the billing related details of the low priority virtual machines in the scale set. (Inherited from IWithBillingProfile) |
| WithNewProximityPlacementGroup(String, ProximityPlacementGroupType) |
Creates a new proximity placement group with the specified name and then adds it to the VM scale set. (Inherited from IWithProximityPlacementGroup) |
| WithNewResourceGroup() | (Inherited from IWithNewResourceGroup<T>) |
| WithNewResourceGroup(ICreatable<IResourceGroup>) |
Creates a new resource group to put the resource in, based on the definition specified. (Inherited from IWithCreatableResourceGroup<T>) |
| WithNewResourceGroup(String) | (Inherited from IWithNewResourceGroup<T>) |
| WithNewStorageAccount(ICreatable<IStorageAccount>) |
Specifies a new storage account for the OS and data disk VHDs of the virtual machines in the scale set. (Inherited from IWithStorageAccount) |
| WithNewStorageAccount(String) |
Specifies a new storage account for the OS and data disk VHDs of the virtual machines in the scale set. (Inherited from IWithStorageAccount) |
| WithNewUserAssignedManagedServiceIdentity(ICreatable<IIdentity>) |
Specifies the definition of a not-yet-created user assigned identity to be associated with the virtual machine scale set. (Inherited from IWithUserAssignedManagedServiceIdentity) |
| WithOSDiskCaching(CachingTypes) |
Specifies the caching type for the operating system disk. (Inherited from IWithOSDiskSettings) |
| WithOSDiskName(String) |
Specifies the name for the OS disk. (Inherited from IWithOSDiskSettings) |
| WithoutAcceleratedNetworking() |
Specify that accelerated networking should be disabled for the virtual machine scale set. (Inherited from IWithAcceleratedNetworking) |
| WithoutIpForwarding() |
Specify that ip forwarding should be disabled for the virtual machine scale set. (Inherited from IWithIpForwarding) |
| WithoutOverProvisioning() |
Disables over-provisioning of virtual machines. (Inherited from IWithOverProvision) |
| WithoutPrimaryInternalLoadBalancer() |
Specifies that no internal load balancer should be associated with the primary network interfaces of the virtual machines in the scale set. (Inherited from IWithPrimaryInternalLoadBalancer) |
| WithoutPrimaryInternetFacingLoadBalancer() |
Specifies that no public load balancer should be associated with the virtual machine scale set. (Inherited from IWithPrimaryInternetFacingLoadBalancer) |
| WithoutSinglePlacementGroup() |
Specify that single placement group should be disabled for the virtual machine scale set. (Inherited from IWithSinglePlacementGroup) |
| WithOverProvision(Boolean) |
Enables or disables over-provisioning of virtual machines in the scale set. (Inherited from IWithOverProvision) |
| WithOverProvisioning() |
Enables over-provisioning of virtual machines. (Inherited from IWithOverProvision) |
| WithPopularLinuxImage(KnownLinuxVirtualMachineImage) |
Specifies a known marketplace Linux image used as the virtual machine's operating system. (Inherited from IWithOS) |
| WithPopularWindowsImage(KnownWindowsVirtualMachineImage) |
Specifies a known marketplace Windows image used as the operating system for the virtual machines in the scale set. (Inherited from IWithOS) |
| WithPrimaryInternalLoadBalancerBackends(String[]) |
Associates the specified backends of the selected load balancer with the primary network interface of the virtual machines in the scale set. (Inherited from IWithInternalLoadBalancerBackendOrNatPool) |
| WithPrimaryInternalLoadBalancerInboundNatPools(String[]) |
Associate internal load balancer inbound NAT pools with the the primary network interface of the scale set virtual machine. (Inherited from IWithInternalInternalLoadBalancerNatPool) |
| WithPrimaryInternetFacingLoadBalancerBackends(String[]) |
Associates the specified backends of the selected load balancer with the primary network interface of the virtual machines in the scale set. (Inherited from IWithPrimaryInternetFacingLoadBalancerBackendOrNatPool) |
| WithPrimaryInternetFacingLoadBalancerInboundNatPools(String[]) |
Associates the specified inbound NAT pools of the selected internal load balancer with the primary network interface of the virtual machines in the scale set. (Inherited from IWithPrimaryInternetFacingLoadBalancerNatPool) |
| WithProximityPlacementGroup(String) |
Set information about the proximity placement group that the virtual machine scale set should be assigned to. (Inherited from IWithProximityPlacementGroup) |
| WithRegion(Region) |
Specifies the region for the resource. (Inherited from IDefinitionWithRegion<T>) |
| WithRegion(String) |
Specifies the region for the resource by name. (Inherited from IDefinitionWithRegion<T>) |
| WithSinglePlacementGroup() |
Specify that single placement group should be enabled for the virtual machine scale set. (Inherited from IWithSinglePlacementGroup) |
| WithSku(IVirtualMachineScaleSetSku) |
Specifies the SKU for the virtual machines in the scale set. (Inherited from IWithSku) |
| WithSku(VirtualMachineScaleSetSkuTypes) |
Specifies the SKU for the virtual machines in the scale set. (Inherited from IWithSku) |
| WithSpecificLinuxImageVersion(ImageReference) |
Specifies the specific version of a market-place Linux image that should be used. (Inherited from IWithOS) |
| WithSpecificWindowsImageVersion(ImageReference) |
Specifies the specific version of a marketplace Windows image needs to be used. (Inherited from IWithOS) |
| WithStoredLinuxImage(String) |
Specifies the user (custom) Linux image used as the virtual machine's operating system. (Inherited from IWithOS) |
| WithStoredWindowsImage(String) |
Specifies the user (custom) Windows image to be used as the operating system for the virtual machines in the scale set. (Inherited from IWithOS) |
| WithSystemAssignedManagedServiceIdentity() |
Specifies that System Assigned (Local) Managed Service Identity needs to be enabled in the virtual machine scale set. (Inherited from IWithSystemAssignedManagedServiceIdentity) |
| WithTag(String, String) |
Adds a tag to the resource. (Inherited from IDefinitionWithTags<T>) |
| WithTags(IDictionary<String,String>) |
Specifies tags for the resource as a {@link Map}. (Inherited from IDefinitionWithTags<T>) |
| WithUpgradeMode(UpgradeMode) |
Specifies the virtual machine scale set upgrade policy mode. (Inherited from IWithUpgradePolicy) |
| WithVirtualMachinePriority(VirtualMachinePriorityTypes) |
Specifies the priority of the virtual machines in the scale set. (Inherited from IWithVMPriority) |
| WithVirtualMachinePublicIp() |
Specify that virtual machines in the scale set should have public ip address. (Inherited from IWithVirtualMachinePublicIp) |
| WithVirtualMachinePublicIp(String) |
Specify that virtual machines in the scale set should have public ip address. (Inherited from IWithVirtualMachinePublicIp) |
| WithVirtualMachinePublicIp(VirtualMachineScaleSetPublicIPAddressConfiguration) |
Specify that virtual machines in the scale set should have public ip address. (Inherited from IWithVirtualMachinePublicIp) |
| WithWindowsCustomImage(String) |
Specifies the ID of a Windows custom image to be used. (Inherited from IWithOS) |
| WithWindowsGalleryImageVersion(String) |
Specifies the resource ID of a Windows gallery image version to be used as the virtual machine scaleset OS. (Inherited from IWithOSBeta) |
Applies to
Azure SDK for .NET
Feedback
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.
Submit and view feedback for