Get-AzCapacityReservationGroup
Gets the properties of Capacity Reservation Groups
Syntax
DefaultParameterSet (Default)
Get-AzCapacityReservationGroup
[-ResourceGroupName <String>]
[-Name <String>]
[-InstanceView]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIDParameterSet
Get-AzCapacityReservationGroup
-ResourceId <String>
[-InstanceView]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIdsOnlyParameterSet
Get-AzCapacityReservationGroup
[-ResourceIdsOnly <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.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, 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
-InstanceView
Get the Instance View of the Capacity Reservation Group.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Name
Specifies the name of the capacity reservation group.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False Aliases: CapacityReservationGroupName
Parameter sets
DefaultParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Specifies the name of a resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
DefaultParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
Resource ID for the capacity reservation group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceIDParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-ResourceIdsOnly
Resource ID's Only for your capacity reservation group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceIdsOnlyParameterSet
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: True 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 .
Outputs
