You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve cmdlet descriptions and parameter descriptions for VM/VMSS creation. (#19583)
* Feature/cplat new az vm improvements (#19582)
* update with Get-AzComputeResourceSku information in md files
* update md
* update
* update
* update md files
* update
* update
* a
* a
* update
* a
* a
* a
* update
* a
* a
* a
* a
* a
* a
* a
* a
* changelog
* Update New-AzVM.md
* a
* a
* a
* a
Co-authored-by: Theodore Chang <[email protected]>
* Feature/cplat new az vm improvements (#19644)
* update with Get-AzComputeResourceSku information in md files
* update md
* update
* update
* update md files
* update
* update
* a
* a
* update
* a
* a
* a
* update
* a
* a
* a
* a
* a
* a
* a
* a
* changelog
* Update New-AzVM.md
* a
* a
* a
* a
* update heading
Co-authored-by: Theodore Chang <[email protected]>
* update heading
* Update New-AzVmss.md
* Update New-AzVmss.md
* suppress false static analysis example issues
* Update ChangeLog.md
Co-authored-by: Theodore Chang <[email protected]>
Co-authored-by: Yunchi Wang <[email protected]>
The **New-AzVM** cmdlet creates a virtual machine in Azure.
60
-
This cmdlet takes a virtual machine object as input.
61
-
Use the New-AzVMConfig cmdlet to create a virtual machine object.
62
-
The **New-AzVM** cmdlet will create a new storage account for boot diagnostics if one does not already exist.
63
-
Other cmdlets can be used to configure the virtual machine, such as Set-AzVMOperatingSystem, Set-AzVMSourceImage, Add-AzVMNetworkInterface, and Set-AzVMOSDisk.
64
-
The `SimpleParameterSet` provides a convenient method to create a VM by making common VM creation arguments optional.
60
+
This cmdlet takes a virtual machine object as input. The **New-AzVM** cmdlet will create a new storage account for boot diagnostics if one does not already exist. <br> <br>
61
+
Use the **[New-AzVMConfig](https://docs.microsoft.com/en-us/powershell/module/az.compute/new-azvmconfig)** cmdlet to create a virtual machine object. <br>
62
+
Then use the following cmdlets to set different properties of the virtual machine object:
63
+
-**[Add-AzVMNetworkInterface](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmnetworkinterface)** to set the network profile.<br>
64
+
-**[Set-AzVMOperatingSystem](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmoperatingsystem)** to set the OS profile. <br>
65
+
-**[Set-AzVMSourceImage](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmsourceimage)** to set the source image.<br>
66
+
-**[Set-AzVMOSDisk](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmosdisk)** to set the OS disk(storage profile).<br>
67
+
-**[Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br>
68
+
<br>
69
+
The `SimpleParameterSet` provides a convenient method to create a VM by making common VM creation arguments optional.<br>
70
+
<br>
71
+
See [Quickstart: Create a Windows virtual machine in Azure with PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/quick-create-powershell) for tutorial. <br>
The Virtual Machine Size. The Default Value is: Standard_D2s_v3.
940
+
The Virtual Machine Size. [Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region.<br>
The **New-AzVMConfig** cmdlet creates a configurable local virtual machine object for Azure.
39
-
Other cmdlets can be used to configure a virtual machine object, such as Set-AzVMOperatingSystem, Set-AzVMSourceImage, Add-AzVMNetworkInterface, and Set-AzVMOSDisk.
38
+
The **New-AzVMConfig** cmdlet creates a configurable local virtual machine object for Azure. <br>
39
+
40
+
The following cmdlets are used to set different properties of the virtual machine object: <br>
41
+
-**[Add-AzVMNetworkInterface](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmnetworkinterface)** to set the network profile.<br>
42
+
-**[Set-AzVMOperatingSystem](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmoperatingsystem)** to set the OS profile. <br>
43
+
-**[Set-AzVMSourceImage](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmsourceimage)** to set the source image.<br>
44
+
-**[Set-AzVMOSDisk](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmosdisk)** to set the OS disk (storage profile).<br>
45
+
-**[Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br>
46
+
<br>
47
+
See [Quickstart: Create a Windows virtual machine in Azure with PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/quick-create-powershell) for tutorial. <br>
Specifies the size for the virtual machine. [Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region.
The **New-AzVmss** cmdlet creates a Virtual Machine Scale Set (VMSS) in Azure.
43
-
Use the simple parameter set (`SimpleParameterSet`) to quickly create a pre-set VMSS and associated resources. Use the default parameter set (`DefaultParameter`) for more advanced scenarios when you need to precisely configure each component of the VMSS and each associated resource before creation.
43
+
Use the simple parameter set (`SimpleParameterSet`) to quickly create a pre-set VMSS and associated resources. <br>
44
+
45
+
Use the default parameter set (`DefaultParameter`) for more advanced scenarios when you need to precisely configure each component of the VMSS and each associated resource before creation.
46
+
For default parameter set, first use the **[New-AzVmssConfig](https://docs.microsoft.com/en-us/powershell/module/az.compute/new-azvmss)** cmdlet to create a virtual machine scale set object. <br> <br>
47
+
48
+
Then use the following cmdlets to set different properties of the virtual machine scale set object: <br>
49
+
-**[Add-AzVmssNetworkInterfaceConfiguration](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmssnetworkinterfaceconfiguration)** to set the network profile.<br>
50
+
-**[Set-AzVmssOsProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssosprofile)** to set the OS profile. <br>
51
+
-**[Set-AzVmssStorageProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssstorageprofile)** to set the storage profile.<br>
52
+
-**[Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br><br>
53
+
54
+
See other cmdlets for virtual machine scale set [here](https://learn.microsoft.com/en-us/powershell/module/az.compute/#vm-scale-sets).<br>
55
+
<br>
56
+
See [Quickstart: Create a virtual machine scale set with Azure PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/quick-create-powershell) for tutorial.
The size of the VM instances in this scale set. A default size (Standard_DS1_v2) will be used if no Size is specified.
929
+
The size of the VM instances in this scale set. [Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region. A default size (Standard_DS1_v2) will be used if no Size is specified.
The **New-AzVmssConfig** cmdlet creates a configurable local Virtual Manager Scale Set (VMSS)
57
-
object. Other cmdlets are needed to configure the VMSS object. These cmdlets are:
58
-
- Set-AzVmssOsProfile
59
-
- Set-AzVmssStorageProfile
60
-
- Add-AzVmssNetworkInterfaceConfiguration
61
-
- Add-AzVmssExtension
57
+
object. <br>
58
+
59
+
Use the following cmdlets to configure the VMSS object:
60
+
-**[Add-AzVmssNetworkInterfaceConfiguration](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmssnetworkinterfaceconfiguration)** to set the network profile.<br>
61
+
-**[Set-AzVmssOsProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssosprofile)** to set the OS profile. <br>
62
+
-**[Set-AzVmssStorageProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssstorageprofile)** to set the storage profile.<br>
63
+
-**[Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br><br>
64
+
65
+
See other cmdlets for virtual machine scale set [here](https://learn.microsoft.com/en-us/powershell/module/az.compute/#vm-scale-sets).<br>
66
+
<br>
67
+
See [Quickstart: Create a virtual machine scale set with Azure PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/quick-create-powershell) for tutorial.
Specifies the size of all the instances of VMSS. [Get-AzComputeResourceSku](https://docs.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region.
<li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/devops/organizations/settings/naming-restrictions).
232
+
**Minimum-length:** 1 character <br>
233
+
**Max-length:** 20 characters for Windows, 64 characters for Linux <br>
234
+
For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/devops/organizations/settings/naming-restrictions).
Copy file name to clipboardExpand all lines: tools/StaticAnalysis/Exceptions/Az.Compute/ExampleIssues.csv
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,4 +5,9 @@
5
5
"Compute","New-AzGalleryImageDefinition","4","11","Invalid_Cmdlet","5000","1","????? is not a valid command name.","?????","Check the spell of ?????."
6
6
"Compute","New-AzGalleryImageDefinition","4","11","Invalid_Cmdlet","5000","1","?????Name='SecurityType' is not a valid command name.","?????Name='SecurityType'","Check the spell of ?????Name='SecurityType'."
7
7
"Compute","New-AzGalleryImageDefinition","4","11","Invalid_Cmdlet","5000","1","Value='ConfidentialVMSupported' is not a valid command name.","Value='ConfidentialVMSupported'","Check the spell of Value='ConfidentialVMSupported'."
8
-
"Compute","New-AzGalleryImageVersion","9","10","Invalid_Cmdlet","5000","1","EncryptedWithCmk is not a valid command name.","EncryptedWithCmk","Check the spell of EncryptedWithCmk."
8
+
"Compute","New-AzGalleryImageVersion","9","10","Invalid_Cmdlet","5000","1","EncryptedWithCmk is not a valid command name.","EncryptedWithCmk","Check the spell of EncryptedWithCmk."
9
+
"Compute","New-AzVM","7","3","Invalid_Cmdlet","5000","1","New-AzResourceGroup is not a valid command name.","New-AzResourceGroup -Name $rgname -Location $loc -Force","Check the spell of New-AzResourceGroup."
10
+
"Compute","New-AzVmss","2","5","Invalid_Cmdlet","5000","1","New-AzResourceGroup is not a valid command name.","New-AzResourceGroup -Name $RGName -Location $LOC -Force","Check the spell of New-AzResourceGroup."
11
+
"Compute","New-AzVmss","2","10","Invalid_Cmdlet","5000","1","New-AzStorageAccount is not a valid command name.","New-AzStorageAccount -ResourceGroupName $RGName -Name $STOName -Location $LOC -Type $STOType","Check the spell of New-AzStorageAccount."
12
+
"Compute","New-AzVmss","2","11","Invalid_Cmdlet","5000","1","Get-AzStorageAccount is not a valid command name.","Get-AzStorageAccount -ResourceGroupName $RGName -Name $STOName","Check the spell of Get-AzStorageAccount."
13
+
"Compute","New-AzVmss","4","4","Invalid_Cmdlet","5000","1","New-AzResourceGroup is not a valid command name.","New-AzResourceGroup -Name $rgname -Location $loc -Force","Check the spell of New-AzResourceGroup."
0 commit comments