Edit

Share via

Remove-AzCapacityReservation

  • Reference
Module:
Az.Compute

Removes a Capacity Reservation resource

Syntax

Remove-AzCapacityReservation
      -ResourceGroupName <String>
      -ReservationGroupName <String>
      [-Name <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzCapacityReservation cmdlet removes a Capacity Reservation resource

Examples

Example 1

Remove-AzCapacityReservation -ResourceGroupName "myRG" -ReservationGroupName "myCapacityReservationGroup" -Name "myCapacityReservation"

This command removes the Capacity Reservation resource.

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

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

-Name

Specifies the name of the capacity reservation resource.

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

-ReservationGroupName

Specifies the name of the capacity reservation group.

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

-ResourceGroupName

Specifies the name of a resource group.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSOperationStatusResponse