pricings

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

Overview

Name	pricings
Type	Resource
Id	azure.security.pricings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deprecated	boolean	Optional. True if the plan is deprecated. If there are replacing plans they will appear in replacedBy property.
enablementTime	string (date-time)	Optional. If pricingTier is Standard then this property holds the date of the last time the pricingTier was set to Standard, when available (e.g 2023-03-01T12:42:42.1921106Z).
enforce	string	If set to "False", it allows the descendants of this scope to override the pricing configuration set on this scope (allows setting inherited="False"). If set to "True", it prevents overrides and forces this pricing configuration on all the descendants of this scope. This field is only available for subscription-level pricing. Known values are: "False" and "True". (False, True)
extensions	array	Optional. List of extensions offered under a plan.
freeTrialRemainingTime	string	The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S).
inherited	string	"inherited" = "True" indicates that the current scope inherits its pricing configuration from its parent. The ID of the parent scope that provides the inherited configuration is displayed in the "inheritedFrom" field. On the other hand, "inherited" = "False" indicates that the current scope has its own pricing configuration explicitly set, and does not inherit from its parent. This field is read only and available only for resource-level pricing. Known values are: "True" and "False". (True, False)
inheritedFrom	string	The id of the scope inherited from. "Null" if not inherited. This field is only available for resource-level pricing.
pricingTier	string	Indicates whether the Defender plan is enabled on the selected scope. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features. Required. Known values are: "Free" and "Standard". (Free, Standard)
replacedBy	array	Optional. List of plans that replace this plan. This property exists only if this plan is deprecated.
resourcesCoverageStatus	string	This field is available for subscription-level only, and reflects the coverage status of the resources under the subscription. Please note: The "pricingTier" field reflects the plan status of the subscription. However, since the plan status can also be defined at the resource level, there might be misalignment between the subscription's plan status and the resource status. This field helps indicate the coverage status of the resources. Known values are: "FullyCovered", "PartiallyCovered", and "NotCovered". (FullyCovered, PartiallyCovered, NotCovered)
subPlan	string	The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied. For VirtualMachines plan, available sub plans are 'P1' & 'P2', where for resource level only 'P1' sub plan is supported.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deprecated	boolean	Optional. True if the plan is deprecated. If there are replacing plans they will appear in replacedBy property.
enablementTime	string (date-time)	Optional. If pricingTier is Standard then this property holds the date of the last time the pricingTier was set to Standard, when available (e.g 2023-03-01T12:42:42.1921106Z).
enforce	string	If set to "False", it allows the descendants of this scope to override the pricing configuration set on this scope (allows setting inherited="False"). If set to "True", it prevents overrides and forces this pricing configuration on all the descendants of this scope. This field is only available for subscription-level pricing. Known values are: "False" and "True". (False, True)
extensions	array	Optional. List of extensions offered under a plan.
freeTrialRemainingTime	string	The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S).
inherited	string	"inherited" = "True" indicates that the current scope inherits its pricing configuration from its parent. The ID of the parent scope that provides the inherited configuration is displayed in the "inheritedFrom" field. On the other hand, "inherited" = "False" indicates that the current scope has its own pricing configuration explicitly set, and does not inherit from its parent. This field is read only and available only for resource-level pricing. Known values are: "True" and "False". (True, False)
inheritedFrom	string	The id of the scope inherited from. "Null" if not inherited. This field is only available for resource-level pricing.
pricingTier	string	Indicates whether the Defender plan is enabled on the selected scope. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features. Required. Known values are: "Free" and "Standard". (Free, Standard)
replacedBy	array	Optional. List of plans that replace this plan. This property exists only if this plan is deprecated.
resourcesCoverageStatus	string	This field is available for subscription-level only, and reflects the coverage status of the resources under the subscription. Please note: The "pricingTier" field reflects the plan status of the subscription. However, since the plan status can also be defined at the resource level, there might be misalignment between the subscription's plan status and the resource status. This field helps indicate the coverage status of the resources. Known values are: "FullyCovered", "PartiallyCovered", and "NotCovered". (FullyCovered, PartiallyCovered, NotCovered)
subPlan	string	The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied. For VirtualMachines plan, available sub plans are 'P1' & 'P2', where for resource level only 'P1' sub plan is supported.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope_id, pricing_name		Get the Defender plans pricing configurations of the selected scope (valid scopes are resource id or a subscription id). At the resource level, supported resource types are 'VirtualMachines, VMSS and ARC Machines'.
list	select	scope_id	$filter	Lists Microsoft Defender for Cloud pricing configurations of the scopeId, that match the optional given $filter. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines'). Valid $filter is: 'name in ({planName1},{planName2},...)'. If $filter is not provided, the unfiltered list will be returned. If '$filter=name in (planName1,planName2)' is provided, the returned list includes the pricings set for 'planName1' and 'planName2' only.
update	update	scope_id, pricing_name		Updates a provided Microsoft Defender for Cloud pricing configuration in the scope. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines' and only for plan='VirtualMachines' and subPlan='P1').
delete	delete	scope_id, pricing_name		Deletes a provided Microsoft Defender for Cloud pricing configuration in a specific resource. Valid only for resource scope (Supported resources are: 'VirtualMachines, VMSS, ARC Machines, and Containers').

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
pricing_name	string	name of the pricing configuration. Required.
scope_id	string	The fully qualified Azure Resource manager identifier of the resource. Required.
$filter	string	OData filter. Optional. Default value is None.

SELECT examples

get

Get the Defender plans pricing configurations of the selected scope (valid scopes are resource id or a subscription id). At the resource level, supported resource types are 'VirtualMachines, VMSS and ARC Machines'.

SELECT
id,
name,
deprecated,
enablementTime,
enforce,
extensions,
freeTrialRemainingTime,
inherited,
inheritedFrom,
pricingTier,
replacedBy,
resourcesCoverageStatus,
subPlan,
systemData,
type
FROM azure.security.pricings
WHERE scope_id = '{{ scope_id }}' -- required
AND pricing_name = '{{ pricing_name }}' -- required
;

list

Lists Microsoft Defender for Cloud pricing configurations of the scopeId, that match the optional given $filter. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines'). Valid $filter is: 'name in ({planName1},{planName2},...)'. If $filter is not provided, the unfiltered list will be returned. If '$filter=name in (planName1,planName2)' is provided, the returned list includes the pricings set for 'planName1' and 'planName2' only.

SELECT
id,
name,
deprecated,
enablementTime,
enforce,
extensions,
freeTrialRemainingTime,
inherited,
inheritedFrom,
pricingTier,
replacedBy,
resourcesCoverageStatus,
subPlan,
systemData,
type
FROM azure.security.pricings
WHERE scope_id = '{{ scope_id }}' -- required
AND $filter = '{{ $filter }}'
;

UPDATE examples

update

Updates a provided Microsoft Defender for Cloud pricing configuration in the scope. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines' and only for plan='VirtualMachines' and subPlan='P1').

UPDATE azure.security.pricings
SET 
properties = '{{ properties }}'
WHERE 
scope_id = '{{ scope_id }}' --required
AND pricing_name = '{{ pricing_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a provided Microsoft Defender for Cloud pricing configuration in a specific resource. Valid only for resource scope (Supported resources are: 'VirtualMachines, VMSS, ARC Machines, and Containers').

DELETE FROM azure.security.pricings
WHERE scope_id = '{{ scope_id }}' --required
AND pricing_name = '{{ pricing_name }}' --required
;