Share via

SecureScoreControlDetails interface

  • Reference
Package:
@azure/arm-security

Details of the security control, its score, and the health status of the relevant resources.

Extends
Resource

Properties

current

Current score NOTE: This property will not be serialized. It can only be populated by the server.
definition

Information about the security control.
displayName

User friendly display name of the control NOTE: This property will not be serialized. It can only be populated by the server.
healthyResourceCount

Number of healthy resources in the control NOTE: This property will not be serialized. It can only be populated by the server.
max

Maximum score available NOTE: This property will not be serialized. It can only be populated by the server.
notApplicableResourceCount

Number of not applicable resources in the control NOTE: This property will not be serialized. It can only be populated by the server.
percentage

Ratio of the current score divided by the maximum. Rounded to 4 digits after the decimal point NOTE: This property will not be serialized. It can only be populated by the server.
unhealthyResourceCount

Number of unhealthy resources in the control NOTE: This property will not be serialized. It can only be populated by the server.
weight

The relative weight for this specific control in each of your subscriptions. Used when calculating an aggregated score for this control across all of your subscriptions. NOTE: This property will not be serialized. It can only be populated by the server.

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

current

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

current?: number

Property Value

number

definition

Information about the security control.

definition?: SecureScoreControlDefinitionItem

Property Value

SecureScoreControlDefinitionItem

displayName

User friendly display name of the control NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

healthyResourceCount

Number of healthy resources in the control NOTE: This property will not be serialized. It can only be populated by the server.

healthyResourceCount?: number

Property Value

number

max

Maximum score available NOTE: This property will not be serialized. It can only be populated by the server.

max?: number

Property Value

number

notApplicableResourceCount

Number of not applicable resources in the control NOTE: This property will not be serialized. It can only be populated by the server.

notApplicableResourceCount?: number

Property Value

number

percentage

Ratio of the current score divided by the maximum. Rounded to 4 digits after the decimal point NOTE: This property will not be serialized. It can only be populated by the server.

percentage?: number

Property Value

number

unhealthyResourceCount

Number of unhealthy resources in the control NOTE: This property will not be serialized. It can only be populated by the server.

unhealthyResourceCount?: number

Property Value

number

weight

The relative weight for this specific control in each of your subscriptions. Used when calculating an aggregated score for this control across all of your subscriptions. NOTE: This property will not be serialized. It can only be populated by the server.

weight?: number

Property Value

number

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