Get-AzureRmVmss

NAME Get-AzureRmVmss



SYNOPSIS

Gets the properties of a VMSS.





SYNTAX

Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-DefaultProfile <IAzureContextContainer>] -InstanceView

[<CommonParameters>]





DESCRIPTION

The Get-AzureRmVmss 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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InstanceView [<SwitchParameter>]

Indicates that this cmdlet gets only the instance view of the virtual machine.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the Resource Group of the VMSS.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VMScaleSetName <String>

Species the name of the VMSS.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

This cmdlet does not generate any output.







NOTES









Example 1: Get the properties of a VMSS



PS C:\\> Get-AzureRmVmss -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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... zurermvmss

New-AzureRmVmss

Remove-AzureRmVmss

Restart-AzureRmVmss

Set-AzureRmVmss

Restart-AzureRmVmss

Stop-AzureRmVmss

Update-AzureRmVmss