Get-AzStandbyVMPoolStatus

Module:

Az.StandbyPool

Get a StandbyVirtualMachinePoolRuntimeViewResource

Syntax

Get-AzStandbyVMPoolStatus
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStandbyVMPoolStatus
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStandbyVMPoolStatus
   -InputObject <IStandbyPoolIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStandbyVMPoolStatus
   -StandbyVirtualMachinePoolInputObject <IStandbyPoolIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a StandbyVirtualMachinePoolRuntimeViewResource

Examples

Example 1: Get runtime view of a standby virtual machine pool

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

Id                           : /subscriptions/f8da6e30-a9d8-48ab-b05c-3f7fe482e13b/resourceGroups/test-standbypool/providers/Microsoft.Standb
                               yPool/standbyVirtualMachinePools/testPool/runtimeViews/latest
InstanceCountSummary         : {{
                                 "instanceCountsByState": [
                                   {
                                     "state": "Creating",
                                     "count": 0
                                   },
                                   {
                                     "state": "Starting",
                                     "count": 0
                                   },
                                   {
                                     "state": "Running",
                                     "count": 1
                                   },
                                   {
                                     "state": "Deallocating",
                                     "count": 0
                                   },
                                   {
                                     "state": "Deallocated",
                                     "count": 0
                                   },
                                   {
                                     "state": "Deleting",
                                     "count": 0
                                   }
                                 ]
                               }}
Name                         : latest
ProvisioningState            : Succeeded
ResourceGroupName            : test-standbypool
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : Microsoft.StandbyPool/standbyVirtualMachinePools/runtimeViews

Above command is getting a runtime veiw of 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
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

Inputs

IStandbyPoolIdentity

Outputs

IStandbyVirtualMachinePoolRuntimeViewResource