Share via

Pricing interface

  • Reference
Package:
@azure/arm-security

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.

Extends
Resource

Properties

deprecated

Optional. True if the plan is deprecated. If there are replacing plans they will appear in replacedBy property NOTE: This property will not be serialized. It can only be populated by the server.
enablementTime

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). NOTE: This property will not be serialized. It can only be populated by the server.
enforce

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.
extensions

Optional. List of extensions offered under a plan.
freeTrialRemainingTime

The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S). NOTE: This property will not be serialized. It can only be populated by the server.
inherited

"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. NOTE: This property will not be serialized. It can only be populated by the server.
inheritedFrom

The id of the scope inherited from. "Null" if not inherited. This field is only available for resource-level pricing. NOTE: This property will not be serialized. It can only be populated by the server.
pricingTier

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.
replacedBy

Optional. List of plans that replace this plan. This property exists only if this plan is deprecated. NOTE: This property will not be serialized. It can only be populated by the server.
resourcesCoverageStatus

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. NOTE: This property will not be serialized. It can only be populated by the server.
subPlan

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.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

deprecated

Optional. True if the plan is deprecated. If there are replacing plans they will appear in replacedBy property NOTE: This property will not be serialized. It can only be populated by the server.

deprecated?: boolean

Property Value

boolean

enablementTime

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). NOTE: This property will not be serialized. It can only be populated by the server.

enablementTime?: Date

Property Value

Date

enforce

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.

enforce?: string

Property Value

string

extensions

Optional. List of extensions offered under a plan.

extensions?: Extension[]

Property Value

Extension[]

freeTrialRemainingTime

The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S). NOTE: This property will not be serialized. It can only be populated by the server.

freeTrialRemainingTime?: string

Property Value

string

inherited

"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. NOTE: This property will not be serialized. It can only be populated by the server.

inherited?: string

Property Value

string

inheritedFrom

The id of the scope inherited from. "Null" if not inherited. This field is only available for resource-level pricing. NOTE: This property will not be serialized. It can only be populated by the server.

inheritedFrom?: string

Property Value

string

pricingTier

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.

pricingTier?: string

Property Value

string

replacedBy

Optional. List of plans that replace this plan. This property exists only if this plan is deprecated. NOTE: This property will not be serialized. It can only be populated by the server.

replacedBy?: string[]

Property Value

string[]

resourcesCoverageStatus

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. NOTE: This property will not be serialized. It can only be populated by the server.

resourcesCoverageStatus?: string

Property Value

string

subPlan

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.

subPlan?: string

Property Value

string

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type