Get-AzStandbyVMPoolVM

  • Reference
Module:
Az.StandbyPool

Get a StandbyVirtualMachineResource

Syntax

Get-AzStandbyVMPoolVM
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStandbyVMPoolVM
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -VMName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStandbyVMPoolVM
   -VMName <String>
   -StandbyVirtualMachinePoolInputObject <IStandbyPoolIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzStandbyVMPoolVM
   -InputObject <IStandbyPoolIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a StandbyVirtualMachineResource

Examples

Example 1: List virtual machines in standby virtual machine pool

Get-AzStandbyVMPoolVM -Name testPool -SubscriptionId f8da6e30-a9d8-48ab-b05c-3f7fe482e13b -ResourceGroupName test-standbypool

None

Above command is listing virtual machines in standby virtual machine pool

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IStandbyPoolIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Name of the standby virtual machine pool

Type:String
Aliases:StandbyVirtualMachinePoolName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StandbyVirtualMachinePoolInputObject

Identity Parameter

Type:IStandbyPoolIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMName

Name of the standby virtual machine

Type:String
Aliases:StandbyVirtualMachineName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IStandbyPoolIdentity

Outputs

IStandbyVirtualMachineResource