Edit

Get-AzStandbyVMPoolStatus

  • Preview
Module:
Az.StandbyPool Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Get a StandbyVirtualMachinePoolRuntimeViewResource

Syntax

Get (Default) 

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

GetViaIdentity 

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

GetViaIdentityStandbyVirtualMachinePool 

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

List 

Get-AzStandbyVMPoolStatus
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-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

ForecastValueInstancesRequestedCount :
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": 2
                                    },
                                    {
                                      "state": "Deallocating",
                                      "count": 0
                                    },
                                    {
                                      "state": "Deallocated",
                                      "count": 0
                                    },
                                    {
                                      "state": "Hibernating",
                                      "count": 0
                                    },
                                    {
                                      "state": "Hibernated",
                                      "count": 0
                                    },
                                    {
                                      "state": "Deleting",
                                      "count": 0
                                    }
                                  ]
                                }}
Name                         : latest
PredictionForecastInfo       :
PredictionForecastStartTime  :
ProvisioningState            : Succeeded
ResourceGroupName            : test-standbypool
StatusCode                   : HealthState/healthy
StatusMessage                :
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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IStandbyPoolIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Name of the standby virtual machine pool

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StandbyVirtualMachinePoolInputObject

Identity Parameter

Parameter properties

Type:IStandbyPoolIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityStandbyVirtualMachinePool
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

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

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IStandbyPoolIdentity

Outputs

IStandbyVirtualMachinePoolRuntimeViewResource