Get-AzVmss
Gets the properties of a VMSS.
Syntax
Get-AzVmss
[[-ResourceGroupName] <String>]
[[-VMScaleSetName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzVmss
[[-ResourceGroupName] <String>]
[[-VMScaleSetName] <String>]
[-InstanceView]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzVmss cmdlet gets the model and instance view of a Virtual Machine Scale Set (VMSS). The model view is the user specified properties of the virtual machine. The instance view is the instance level status of the virtual machine. Specify the Status parameter to get only the instance view of a virtual machine.
Examples
Example 1: Get the properties of a VMSS
PS C:\> Get-AzVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"This command gets the properties of the VMSS named VMSS001 that belongs to the resource group named Group001. Since the command does not specify the InstanceView switch parameter, the cmdlet gets the model view of the virtual machine.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstanceView
Indicates that this cmdlet gets only the instance view of the virtual machine.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the Resource Group of the VMSS.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMScaleSetName
Species the name of the VMSS.
| Type: | String |
| Aliases: | Name |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
None
This cmdlet does not accept any input.
Outputs
This cmdlet does not generate any output.