settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	azure.cost_management.settings

Fields

The following fields are returned by SELECT queries:

get_by_scope

The request has succeeded.

Name	Datatype	Description
kind	string	Specifies the kind of settings.

list

OK. The request has succeeded.

Name	Datatype	Description
kind	string	Specifies the kind of settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_scope	select	scope, type		Get the setting from the given scope by name.
list	select	scope		List all cost management settings in the requested scope.
delete_by_scope	delete	scope, type		Delete a setting within the given scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
scope	string	The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.
type	string	Setting type.

SELECT examples

get_by_scope

Get the setting from the given scope by name.

SELECT
kind
FROM azure.cost_management.settings
WHERE scope = '{{ scope }}' -- required
AND type = '{{ type }}' -- required
;

list

List all cost management settings in the requested scope.

SELECT
kind
FROM azure.cost_management.settings
WHERE scope = '{{ scope }}' -- required
;

DELETE examples

delete_by_scope

Delete a setting within the given scope.

DELETE FROM azure.cost_management.settings
WHERE scope = '{{ scope }}' --required
AND type = '{{ type }}' --required
;