< Back
Get-AzureRmVmssVM
Post
NAME Get-AzureRmVmssVM
SYNOPSIS
Gets the properties of a VMSS virtual machine.
SYNTAX
Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] [-DefaultProfile <IAzureContextContainer>]
-InstanceView [<CommonParameters>]
DESCRIPTION
The Get-AzureRmVmssVM cmdlet gets the model view and instance view of a Virtual Machine Scale Set (VMSS) virtual machine. 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
-InstanceId <String>
Specifies the instance ID for which to get the model view.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
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 virtual machine
PS C:\\> Get-AzureRmVmssVM -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"
This command gets the properties of the VMSS virtual machine 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.
Example 2: Get the model view properties of a VMSS virtual machine
PS C:\\> Get-AzureRmVmssVM -ResourceGroupName "Group002" -VMScaleSetName "VMSS004" -InstanceId $ID
This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. The command gets the
instance ID stored in the variable $ID for which to get the model view.
Example 3: Get the instance view properties of a VMSS virtual machine
PS C:\\> Get-AzureRmVmssVM -InstanceView -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $ID
This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. Since the command
specifies the InstanceView switch parameter, the cmdlet gets the instance view of the virtual machine. The command gets the instance ID stored in
the variable $ID for which to get the instance view.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rermvmssvm
Set-AzureRmVmssVM
Get-AzureRmVmssDiskEncryption
SYNOPSIS
Gets the properties of a VMSS virtual machine.
SYNTAX
Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] [-DefaultProfile <IAzureContextContainer>]
-InstanceView [<CommonParameters>]
DESCRIPTION
The Get-AzureRmVmssVM cmdlet gets the model view and instance view of a Virtual Machine Scale Set (VMSS) virtual machine. 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
-InstanceId <String>
Specifies the instance ID for which to get the model view.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
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 virtual machine
PS C:\\> Get-AzureRmVmssVM -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"
This command gets the properties of the VMSS virtual machine 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.
Example 2: Get the model view properties of a VMSS virtual machine
PS C:\\> Get-AzureRmVmssVM -ResourceGroupName "Group002" -VMScaleSetName "VMSS004" -InstanceId $ID
This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. The command gets the
instance ID stored in the variable $ID for which to get the model view.
Example 3: Get the instance view properties of a VMSS virtual machine
PS C:\\> Get-AzureRmVmssVM -InstanceView -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $ID
This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. Since the command
specifies the InstanceView switch parameter, the cmdlet gets the instance view of the virtual machine. The command gets the instance ID stored in
the variable $ID for which to get the instance view.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rermvmssvm
Set-AzureRmVmssVM
Get-AzureRmVmssDiskEncryption