Budgets Interface

Package:

com.azure.resourcemanager.consumption.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0-beta.3

public interface Budgets

Resource collection API of Budgets.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Budget resource.
abstract void	deleteById(String id) The operation to delete a budget.
abstract Response<Void>	deleteByIdWithResponse(String id, Context context) The operation to delete a budget.
abstract void	deleteByResourceGroup(String scope, String budgetName) The operation to delete a budget.
abstract Response<Void>	deleteWithResponse(String scope, String budgetName, Context context) The operation to delete a budget.
abstract Budget	get(String scope, String budgetName) Gets the budget for the scope by budget name.
abstract Budget	getById(String id) Gets the budget for the scope by budget name.
abstract Response<Budget>	getByIdWithResponse(String id, Context context) Gets the budget for the scope by budget name.
abstract Response<Budget>	getWithResponse(String scope, String budgetName, Context context) Gets the budget for the scope by budget name.
abstract PagedIterable<Budget>	list(String scope) Lists all budgets for the defined scope.
abstract PagedIterable<Budget>	list(String scope, Context context) Lists all budgets for the defined scope.

Method Details

define

public abstract Budget.DefinitionStages.Blank define(String name)

Begins definition for a new Budget resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Budget definition.

deleteById

public abstract void deleteById(String id)

The operation to delete a budget.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, Context context)

The operation to delete a budget.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the response.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String scope, String budgetName)

The operation to delete a budget.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

budgetName - Budget Name.

deleteWithResponse

public abstract Response deleteWithResponse(String scope, String budgetName, Context context)

The operation to delete a budget.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

budgetName - Budget Name.

context - The context to associate with this operation.

Returns:

the response.

get

public abstract Budget get(String scope, String budgetName)

Gets the budget for the scope by budget name.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

budgetName - Budget Name.

Returns:

the budget for the scope by budget name.

getById

public abstract Budget getById(String id)

Gets the budget for the scope by budget name.

Parameters:

id - the resource ID.

Returns:

the budget for the scope by budget name.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the budget for the scope by budget name.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the budget for the scope by budget name.

getWithResponse

public abstract Response getWithResponse(String scope, String budgetName, Context context)

Gets the budget for the scope by budget name.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

budgetName - Budget Name.

context - The context to associate with this operation.

Returns:

the budget for the scope by budget name.

list

public abstract PagedIterable list(String scope)

Lists all budgets for the defined scope.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

Returns:

result of listing budgets.

list

public abstract PagedIterable list(String scope, Context context)

Lists all budgets for the defined scope.

Parameters:

scope - The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.

context - The context to associate with this operation.

Returns:

result of listing budgets.