@@ -21,16 +21,16 @@ New-AzDiskUpdateConfig [[-SkuName] <String>] [-Tier <String>] [-DiskIOPSReadOnly
2121 [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DiskEncryptionSetId <String>] [-EncryptionType <String>]
2222 [-BurstingEnabled <Boolean>] [-PublicNetworkAccess <String>] [-AcceleratedNetwork <Boolean>]
2323 [-DataAccessAuthMode <String>] [-Architecture <String>] [-DefaultProfile <IAzureContextContainer>]
24- [-WhatIf] [-Confirm] [<CommonParameters>]
24+ [-ProgressAction <ActionPreference>] [- WhatIf] [-Confirm] [<CommonParameters>]
2525```
2626
2727## DESCRIPTION
28- The ** New-AzDiskUpdateConfig** cmdlet creates a configurable disk update object.
28+ The New-AzDiskUpdateConfig cmdlet creates a configurable disk update object.
2929
3030## EXAMPLES
3131
3232### Example 1
33- ``` powershell
33+ ```
3434$diskupdateconfig = New-AzDiskUpdateConfig -DiskSizeGB 10 -SkuName Premium_LRS -OsType Windows -EncryptionSettingsEnabled $true;
3535$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/';
3636$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123';
@@ -41,14 +41,13 @@ $diskupdateconfig = Set-AzDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconf
4141Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig;
4242```
4343
44- The first command creates a local empty disk update object with size 10GB in Premium_LRS storage
45- account type. It also sets Windows OS type and enables encryption settings. The second and third
46- commands set the disk encryption key and key encryption key settings for the disk update object.
47- The last command takes the disk update object and updates an existing disk with name 'Disk01' in
48- resource group 'ResourceGroup01'.
44+ The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type.
45+ It also sets Windows OS type and enables encryption settings.
46+ The second and third commands set the disk encryption key and key encryption key settings for the disk update object.
47+ The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'.
4948
5049### Example 2
51- ``` powershell
50+ ```
5251New-AzDiskUpdateConfig -DiskSizeGB 10 | Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01';
5352```
5453
@@ -72,7 +71,8 @@ Accept wildcard characters: False
7271` ` `
7372
7473### -Architecture
75- CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64".
74+ CPU architecture supported by an OS disk.
75+ Possible values are "X64" and "Arm64".
7676
7777` ` ` yaml
7878Type : System.String
@@ -87,7 +87,9 @@ Accept wildcard characters: False
8787` ` `
8888
8989### -BurstingEnabled
90- Enables bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
90+ Enables bursting beyond the provisioned performance target of the disk.
91+ Bursting is disabled by default.
92+ Does not apply to Ultra disks.
9193
9294` ` ` yaml
9395Type : System.Nullable`1[System.Boolean]
@@ -177,7 +179,8 @@ Accept wildcard characters: False
177179` ` `
178180
179181### -DiskIOPSReadOnly
180- The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
182+ The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.
183+ One operation can transfer between 4k and 256k bytes.
181184
182185` ` ` yaml
183186Type : System.Nullable`1[System.Int64]
@@ -192,7 +195,8 @@ Accept wildcard characters: False
192195` ` `
193196
194197### -DiskIOPSReadWrite
195- The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
198+ The number of IOPS allowed for this disk; only settable for UltraSSD disks.
199+ One operation can transfer between 4k and 256k bytes.
196200
197201` ` ` yaml
198202Type : System.Int32
@@ -207,7 +211,8 @@ Accept wildcard characters: False
207211` ` `
208212
209213### -DiskMBpsReadOnly
210- The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
214+ The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.
215+ MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
211216
212217` ` ` yaml
213218Type : System.Nullable`1[System.Int64]
@@ -222,7 +227,8 @@ Accept wildcard characters: False
222227` ` `
223228
224229### -DiskMBpsReadWrite
225- The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
230+ The bandwidth allowed for this disk; only settable for UltraSSD disks.
231+ MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
226232
227233` ` ` yaml
228234Type : System.Int32
@@ -267,7 +273,8 @@ Accept wildcard characters: False
267273` ` `
268274
269275### -EncryptionType
270- The type of key used to encrypt the data of the disk. Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey
276+ The type of key used to encrypt the data of the disk.
277+ Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey
271278
272279` ` ` yaml
273280Type : System.String
@@ -297,7 +304,8 @@ Accept wildcard characters: False
297304` ` `
298305
299306### -MaxSharesCount
300- The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
307+ The maximum number of VMs that can attach to the disk at the same time.
308+ Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
301309
302310` ` ` yaml
303311Type : System.Nullable`1[System.Int32]
@@ -312,7 +320,7 @@ Accept wildcard characters: False
312320` ` `
313321
314322### -NetworkAccessPolicy
315- Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DeyAll
323+ Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DenyAll
316324
317325` ` ` yaml
318326Type : System.String
@@ -342,6 +350,21 @@ Accept pipeline input: True (ByPropertyName)
342350Accept wildcard characters : False
343351` ` `
344352
353+ ### -ProgressAction
354+ {{ Fill ProgressAction Description }}
355+
356+ ` ` ` yaml
357+ Type : System.Management.Automation.ActionPreference
358+ Parameter Sets : (All)
359+ Aliases : proga
360+
361+ Required : False
362+ Position : Named
363+ Default value : None
364+ Accept pipeline input : False
365+ Accept wildcard characters : False
366+ ` ` `
367+
345368### -PublicNetworkAccess
346369Policy for controlling export on the disk.
347370
@@ -358,7 +381,8 @@ Accept wildcard characters: False
358381` ` `
359382
360383### -PurchasePlan
361- Sets the purchase plan for the disk. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.
384+ Sets the purchase plan for the disk.
385+ Used for establishing the purchase context of any 3rd Party artifact through Marketplace.
362386
363387` ` ` yaml
364388Type : Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan
@@ -373,7 +397,9 @@ Accept wildcard characters: False
373397` ` `
374398
375399### -SkuName
376- Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter.
400+ Specifies the Sku name of the storage account.
401+ Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS.
402+ UltraSSD_LRS can only be used with Empty value for CreateOption parameter.
377403
378404` ` ` yaml
379405Type : System.String
@@ -403,8 +429,8 @@ Accept wildcard characters: False
403429` ` `
404430
405431### -Tag
406- Key-value pairs in the form of a hash table. For example:
407- @{key0="value0";key1=$null;key2="value2"}
432+ Key-value pairs in the form of a hash table.
433+ For example: @{key0="value0";key1=$null;key2="value2"}
408434
409435` ` ` yaml
410436Type : System.Collections.Hashtable
@@ -443,13 +469,14 @@ Aliases: cf
443469
444470Required : False
445471Position : Named
446- Default value : None
472+ Default value : False
447473Accept pipeline input : False
448474Accept wildcard characters : False
449475` ` `
450476
451477### -WhatIf
452- Shows what would happen if the cmdlet runs. The cmdlet is not run.
478+ Shows what would happen if the cmdlet runs.
479+ The cmdlet is not run.
453480
454481` ` ` yaml
455482Type : System.Management.Automation.SwitchParameter
@@ -458,7 +485,7 @@ Aliases: wi
458485
459486Required : False
460487Position : Named
461- Default value : None
488+ Default value : False
462489Accept pipeline input : False
463490Accept wildcard characters : False
464491` ` `
@@ -469,23 +496,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
469496## INPUTS
470497
471498### System.String
472-
473499### System.Nullable` 1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
474-
475500# ## System.Int32
476-
477501# ## System.Collections.Hashtable
478-
479502# ## System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
480-
481503# ## Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference
482-
483504# ## Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference
484-
485505# # OUTPUTS
486506
487507# ## Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate
488-
489508# # NOTES
490509
491510# # RELATED LINKS
0 commit comments