Get-AzConsumptionBudget
Get a list of budgets in either a subscription or a resource group.
Syntax
Default (Default)
Get-AzConsumptionBudget
[-DefaultProfile <IAzureContextContainer>]
[-ResourceGroupName <String>]
[-Name <String>]
[<CommonParameters>]
Description
The Get-AzConsumptionBudget cmdlet gets a list of budgets in either a subscription or a resource group.
Examples
Example 1: Get a list of budgets at subscription level
Get-AzConsumptionBudget
Amount: 60
Category: Cost
CurrentSpend: null
Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget
Name: PSBudget
TimeGrain: Monthly
TimePeriod: EndDate: 11/1/2018 12:00:00 AM
StartDate: 6/1/2018 12:00:00 AM
Type: Microsoft.Consumption/budgets
Example 2: Get a list of budgets at resource group level
Get-AzConsumptionBudget -ResourceGroupName RGBudgets
Amount: 60
Category: Cost
CurrentSpend: null
Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG
Name: PSBudgetRG
TimeGrain: Monthly
TimePeriod: EndDate: 11/1/2018 12:00:00 AM
StartDate: 6/1/2018 12:00:00 AM
Type: Microsoft.Consumption/budgets
Example 3: Get a budget with the budget name at subscription level
Get-AzConsumptionBudget -Name PSBudget
Amount: 60
Category: Cost
CurrentSpend: null
Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget
Name: PSBudget
TimeGrain: Monthly
TimePeriod: EndDate: 11/1/2018 12:00:00 AM
StartDate: 6/1/2018 12:00:00 AM
Type: Microsoft.Consumption/budgets
Example 4: Get a budget with the budget name at resource group level
Get-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG
Amount: 60
Category: Cost
CurrentSpend: null
Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG
Name: PSBudgetRG
TimeGrain: Monthly
TimePeriod: EndDate: 11/1/2018 12:00:00 AM
StartDate: 6/1/2018 12:00:00 AM
Type: Microsoft.Consumption/budgets
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 |
-Name
Name of a budget.
Parameter properties
| Type: | String |
| 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: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
Resource Group of a budget.
Parameter properties
| Type: | String |
| 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: | 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
None
Outputs
PSBudget
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.
