Remove-AzConsumptionBudget

Reference

Module:: Az.Billing

Remove a budget in either a subscription or a resource group.

Syntax

Remove-AzConsumptionBudget
      [-DefaultProfile <IAzureContextContainer>]
      -Name <String>
      [-ResourceGroupName <String>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzConsumptionBudget
      [-DefaultProfile <IAzureContextContainer>]
      -InputObject <PSBudget>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzConsumptionBudget cmdlet removes a budget in either a subscription or a resource group.

Examples

Example 1: Remove a budget with a budget name at subscription level

Remove-AzConsumptionBudget -Name PSBudget -PassThru

True

Example 2: Remove a budget with a budget name at resource group level

Remove-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -PassThru

True

Example 3: Remove a budget through piping at subscription level

Get-AzConsumptionBudget -Name PSBudget | Remove-AzConsumptionBudget -PassThru

True

Parameters

-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

-InputObject

Budget object.

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

-Name

Name of a budget.

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

-PassThru

The Cmdlet returns true if a budget was successfully removed.

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

-ResourceGroupName

Resource Group of a budget.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

PSBudget

Outputs

Boolean

Notes

Currently, PowerShell SDK for Consumption is only available to Enterprise Agreement customers.
PowerShell SDK for Consumption is using an older version of Budgets API and few backwards non-compatible items like listing Budgets with filters will not work as expected.

Partager via