Update-AzVmss
Updates the state of a VMSS.
Update-AzVmss
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
[-AutomaticOSUpgrade <Boolean>]
[-AutomaticRepairGracePeriod <String>]
[-EnableAutomaticRepair <Boolean>]
[-AutomaticRepairAction <String>]
[-BootDiagnosticsEnabled <Boolean>]
[-BootDiagnosticsStorageUri <String>]
[-CustomData <String>]
[-DisableAutoRollback <Boolean>]
[-DisablePasswordAuthentication <Boolean>]
[-EnableAutomaticUpdate <Boolean>]
[-ImageReferenceId <String>]
[-ImageReferenceOffer <String>]
[-ImageReferencePublisher <String>]
[-ImageReferenceSku <String>]
[-ImageReferenceVersion <String>]
[-ImageUri <String>]
[-LicenseType <String>]
[-ManagedDiskStorageAccountType <String>]
[-MaxBatchInstancePercent <Int32>]
[-MaxPrice <Double>]
[-MaxUnhealthyInstancePercent <Int32>]
[-MaxUnhealthyUpgradedInstancePercent <Int32>]
[-OsDiskCaching <CachingTypes>]
[-OsDiskWriteAccelerator <Boolean>]
[-Overprovision <Boolean>]
[-ScaleInPolicyForceDeletion <Boolean>]
[-PauseTimeBetweenBatches <String>]
[-PlanName <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-PlanPublisher <String>]
[-ProvisionVMAgent <Boolean>]
[-ProximityPlacementGroupId <String>]
[-ScaleInPolicy <String[]>]
[-SinglePlacementGroup <Boolean>]
[-SkipExtensionsOnOverprovisionedVMs <Boolean>]
[-SkuCapacity <Int32>]
[-SkuName <String>]
[-SkuTier <String>]
[-Tag <Hashtable>]
[-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
[-TerminateScheduledEvents <Boolean>]
[-TimeZone <String>]
[-UltraSSDEnabled <Boolean>]
[-UpgradePolicyMode <UpgradeMode>]
[-CapacityReservationGroupId <String>]
[-VhdContainer <String[]>]
[-AsJob]
[-EncryptionAtHost <Boolean>]
[-UserData <String>]
[-BaseRegularPriorityCount <Int32>]
[-RegularPriorityPercentage <Int32>]
[-SharedGalleryImageId <String>]
[-OSImageScheduledEventEnabled]
[-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>]
[-SecurityType <String>]
[-EnableVtpm <Boolean>]
[-EnableSecureBoot <Boolean>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SkuProfileVmSize <String[]>]
[-SkuProfileAllocationStrategy <String>]
[-EnableResilientVMCreate <Boolean>]
[-EnableResilientVMDelete <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzVmss
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>]
[-AutomaticOSUpgrade <Boolean>]
[-AutomaticRepairGracePeriod <String>]
[-EnableAutomaticRepair <Boolean>]
[-AutomaticRepairAction <String>]
[-BootDiagnosticsEnabled <Boolean>]
[-BootDiagnosticsStorageUri <String>]
[-CustomData <String>]
[-DisableAutoRollback <Boolean>]
[-DisablePasswordAuthentication <Boolean>]
[-EnableAutomaticUpdate <Boolean>]
[-IdentityId <String[]>]
-IdentityType <ResourceIdentityType>
[-ImageReferenceId <String>]
[-ImageReferenceOffer <String>]
[-ImageReferencePublisher <String>]
[-ImageReferenceSku <String>]
[-ImageReferenceVersion <String>]
[-ImageUri <String>]
[-LicenseType <String>]
[-ManagedDiskStorageAccountType <String>]
[-MaxBatchInstancePercent <Int32>]
[-MaxPrice <Double>]
[-MaxUnhealthyInstancePercent <Int32>]
[-MaxUnhealthyUpgradedInstancePercent <Int32>]
[-OsDiskCaching <CachingTypes>]
[-OsDiskWriteAccelerator <Boolean>]
[-Overprovision <Boolean>]
[-ScaleInPolicyForceDeletion <Boolean>]
[-PauseTimeBetweenBatches <String>]
[-PlanName <String>]
[-PlanProduct <String>]
[-PlanPromotionCode <String>]
[-PlanPublisher <String>]
[-ProvisionVMAgent <Boolean>]
[-ProximityPlacementGroupId <String>]
[-ScaleInPolicy <String[]>]
[-SinglePlacementGroup <Boolean>]
[-SkipExtensionsOnOverprovisionedVMs <Boolean>]
[-SkuCapacity <Int32>]
[-SkuName <String>]
[-SkuTier <String>]
[-Tag <Hashtable>]
[-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>]
[-TerminateScheduledEvents <Boolean>]
[-TimeZone <String>]
[-UltraSSDEnabled <Boolean>]
[-UpgradePolicyMode <UpgradeMode>]
[-CapacityReservationGroupId <String>]
[-VhdContainer <String[]>]
[-AsJob]
[-EncryptionAtHost <Boolean>]
[-UserData <String>]
[-BaseRegularPriorityCount <Int32>]
[-RegularPriorityPercentage <Int32>]
[-SharedGalleryImageId <String>]
[-OSImageScheduledEventEnabled]
[-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>]
[-SecurityType <String>]
[-EnableVtpm <Boolean>]
[-EnableSecureBoot <Boolean>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SkuProfileVmSize <String[]>]
[-SkuProfileAllocationStrategy <String>]
[-EnableResilientVMCreate <Boolean>]
[-EnableResilientVMDelete <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
The Update-AzVmss cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object.
Update-AzVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS
This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object, $LocalVMSS.
Updates the state of a VMSS. (autogenerated)
Update-AzVmss -ResourceGroupName 'Group001' -VMScaleSetName 'VMSS001' -VirtualMachineScaleSet <PSVirtualMachineScaleSet> -IdentityType SystemAssigned
Run cmdlet in the background and return a Job to track progress.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.
Type: | String |
Accepted values: | Replace, Restart, Reimage |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the minimum number of VMs that must be of Regular priority as a VMSS Flex instance scales out. This parameter is only valid for VMSS instances with Flexible OrchestrationMode.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Whether boot diagnostics should be enabled on the virtual machine scale set.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
URI of the storage account to use for placing the console output and screenshot.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Id of the capacity reservation Group that is used to allocate.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies a base-64 encoded string of custom data.
This is decoded to a binary array that is saved as a file on the virtual machine.
The maximum length of the binary array is 65535 bytes.
For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Disable Auto Rollback for Auto OS Upgrade Policy
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates that this cmdlet disables password authentication for Linux OS.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Enable or disable automatic repairs on the virtual machine scale set.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies whether secure boot should be enabled on the virtual machine.
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies whether vTPM should be enabled on the virtual machine.
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
This parameter can be used by user in the request to enable or disable the Host Encryption for the virtual machine scale set.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the type of identity used for the virtual machine scale set. The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. The acceptable values for this parameter are:
- SystemAssigned
- UserAssigned
- SystemAssignedUserAssigned
- None
Type: | Nullable<T>[ResourceIdentityType] |
Accepted values: | SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
used to make a request conditional for the PUT and other non-safe methods. The server will only return the requested resources if the resource matches one of the listed ETag values. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the image reference ID.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the type of virtual machine image (VMImage) offer. To obtain an image offer, use the Get-AzVMImageOffer cmdlet.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the name of a publisher of a VMImage. To obtain a publisher, use the Get-AzVMImagePublisher cmdlet.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the VMImage SKU. To obtain SKUs, use the Get-AzVMImageSku cmdlet.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the version of the VMImage. To use the latest version, specify a value of latest instead of a particular version.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the blob URI for the user image. VMSS creates an operating system disk in the same container of the user image.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specify the license type, which is for bringing your own license scenario.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the storage account type for managed disk. The acceptable values for this parameter are:
- Standard_LRS
- Premium_LRS
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. If the value is not specified, it is set to 20.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.
Type: | Double |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. If the value is not specified, it is set to 20.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. If the value is not specified, it is set to 20.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the caching mode of the operating system disk. The acceptable values for this parameter are:
- None
- ReadOnly
- ReadWrite The default value is ReadWrite. If you change the caching value, the cmdlet will restart the virtual machine. This setting affects the consistency and performance of the disk.
Type: | CachingTypes |
Accepted values: | None, ReadOnly, ReadWrite |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies whether WriteAccelerator should be enabled or disabled on the OS disk.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies whether the OS Image Scheduled event is enabled or disabled.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The length of time a virtual machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, with the value set to 15 minutes (PT15M).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether the cmdlet overprovisions the VMSS.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the plan name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the plan product.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the plan promotion code.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the plan publisher.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The resource id of the Proximity Placement Group to use with this scale set.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the desired percentage of VMs, after the BaseRegularCount has been met, that are of Regular priority as the VMSS Flex instance scales out. This property is only valid for VMSS instances with Flexible OrchestrationMode.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the name of the resource group the VMSS belongs to.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The rules to be followed when scaling-in a virtual machine scale set. Possible values are: 'Default', 'OldestVM' and 'NewestVM'. 'Default' when a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. 'OldestVM' when a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. 'NewestVM' when a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applying Force Deletion when using ScaleIn Policy.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. UefiSettings will not be enabled unless this property is set.
Type: | String |
Accepted values: | TrustedLaunch, ConfidentialVM, Standard |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the single placement group.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies that the extensions do not run on the extra overprovisioned VMs.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the number of instances in the VMSS.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the size of all the instances of VMSS.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Allocation strategy for the SKU profile.
Type: | String |
Accepted values: | LowestPrice, CapacityOptimized |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Array of VM sizes for the scale set.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the tier of VMSS. The acceptable values for this parameter are:
- Standard
- Basic
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Configurable length of time (in minutes) a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out).
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies whether the Terminate Scheduled event is enabled or disabled.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the time zone for Windows OS. e.g. "Pacific Standard Time".
Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specified the mode of an upgrade to virtual machines in the scale set. The acceptable values for this parameter are:
- Automatic
- Manual
- Rolling
Type: | UpgradeMode |
Accepted values: | Automatic, Manual, Rolling |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the container URLs that are used to store operating system disks for the VMSS.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies a local VMSS object. To obtain a VMSS object, use the Get-AzVmss cmdlet. This virtual machine object contains the updated state for the VMSS.
Type: | PSVirtualMachineScaleSet |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the name of the VMSS that this cmdlet creates.
Type: | String |
Aliases: | Name |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Azure PowerShell feedback
Azure PowerShell is an open source project. Select a link to provide feedback: