Get-AzCapacityReservationGroup

Reference

Module:: Az.Compute

Gets the properties of Capacity Reservation Groups

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzCapacityReservationGroup
   [-ResourceGroupName <String>]
   [-Name <String>]
   [-InstanceView]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzCapacityReservationGroup
   -ResourceId <String>
   [-InstanceView]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCapacityReservationGroup cmdlet gets the properties of Capacity Reservation resources from a Capacity Reservation Group

Examples

Example 1

Get-AzCapacityReservationGroup -ResourceGroupName $rgname -Name "CRGroup1" -InstanceView

This will retrieve the Capacity Reservation Group named "CRGroup1" with its instance view information.

Example 2

Get-AzCapacityReservationGroup -ResourceGroupName $rgname

This will retrieve all the Capacity Reservation Groups' information from resource group.

Parameters

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceView

Get the Instance View of the Capacity Reservation Group.

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

-Name

Specifies the name of the capacity reservation group.

Type:	String
Aliases:	CapacityReservationGroupName
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	True

-ResourceGroupName

Specifies the name of a resource group.

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

-ResourceId

Resource ID for the capacity reservation group.

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

Inputs

String

SwitchParameter

Outputs

PSCapacityReservationGroup