Share via

ComponentPolicyState interface

  • Reference
Package:
@azure/arm-policyinsights

Component Policy State record.

Properties

complianceState

Compliance state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
componentId

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

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

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

OData context string; used by OData clients to resolve type information based on metadata. NOTE: This property will not be serialized. It can only be populated by the server.
odataId

OData entity ID; always set to null since component policy state records do not have an entity ID. NOTE: This property will not be serialized. It can only be populated by the server.
policyAssignmentId

Policy assignment ID. NOTE: This property will not be serialized. It can only be populated by the server.
policyAssignmentName

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

Policy assignment owner. NOTE: This property will not be serialized. It can only be populated by the server.
policyAssignmentParameters

Policy assignment parameters. NOTE: This property will not be serialized. It can only be populated by the server.
policyAssignmentScope

Policy assignment scope. NOTE: This property will not be serialized. It can only be populated by the server.
policyAssignmentVersion

Evaluated policy assignment version. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionAction

Policy definition action, i.e. effect. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionCategory

Policy definition category. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionGroupNames

Policy definition group names. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionId

Policy definition ID. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionName

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

Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policyDefinitionVersion

Evaluated policy definition version. NOTE: This property will not be serialized. It can only be populated by the server.
policyEvaluationDetails

Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails.
policySetDefinitionCategory

Policy set definition category, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policySetDefinitionId

Policy set definition ID, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policySetDefinitionName

Policy set definition name, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policySetDefinitionOwner

Policy set definition owner, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policySetDefinitionParameters

Policy set definition parameters, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.
policySetDefinitionVersion

Evaluated policy set definition version. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGroup

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

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

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

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

Subscription ID. NOTE: This property will not be serialized. It can only be populated by the server.
timestamp

Timestamp for the component policy state record. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

complianceState

Compliance state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

complianceState?: string

Property Value

string

componentId

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

componentId?: string

Property Value

string

componentName

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

componentName?: string

Property Value

string

componentType

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

componentType?: string

Property Value

string

odataContext

OData context string; used by OData clients to resolve type information based on metadata. NOTE: This property will not be serialized. It can only be populated by the server.

odataContext?: string

Property Value

string

odataId

OData entity ID; always set to null since component policy state records do not have an entity ID. NOTE: This property will not be serialized. It can only be populated by the server.

odataId?: string

Property Value

string

policyAssignmentId

Policy assignment ID. NOTE: This property will not be serialized. It can only be populated by the server.

policyAssignmentId?: string

Property Value

string

policyAssignmentName

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

policyAssignmentName?: string

Property Value

string

policyAssignmentOwner

Policy assignment owner. NOTE: This property will not be serialized. It can only be populated by the server.

policyAssignmentOwner?: string

Property Value

string

policyAssignmentParameters

Policy assignment parameters. NOTE: This property will not be serialized. It can only be populated by the server.

policyAssignmentParameters?: string

Property Value

string

policyAssignmentScope

Policy assignment scope. NOTE: This property will not be serialized. It can only be populated by the server.

policyAssignmentScope?: string

Property Value

string

policyAssignmentVersion

Evaluated policy assignment version. NOTE: This property will not be serialized. It can only be populated by the server.

policyAssignmentVersion?: string

Property Value

string

policyDefinitionAction

Policy definition action, i.e. effect. NOTE: This property will not be serialized. It can only be populated by the server.

policyDefinitionAction?: string

Property Value

string

policyDefinitionCategory

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

policyDefinitionCategory?: string

Property Value

string

policyDefinitionGroupNames

Policy definition group names. NOTE: This property will not be serialized. It can only be populated by the server.

policyDefinitionGroupNames?: string[]

Property Value

string[]

policyDefinitionId

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

policyDefinitionId?: string

Property Value

string

policyDefinitionName

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

policyDefinitionName?: string

Property Value

string

policyDefinitionReferenceId

Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policyDefinitionReferenceId?: string

Property Value

string

policyDefinitionVersion

Evaluated policy definition version. NOTE: This property will not be serialized. It can only be populated by the server.

policyDefinitionVersion?: string

Property Value

string

policyEvaluationDetails

Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails.

policyEvaluationDetails?: ComponentPolicyEvaluationDetails

Property Value

ComponentPolicyEvaluationDetails

policySetDefinitionCategory

Policy set definition category, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionCategory?: string

Property Value

string

policySetDefinitionId

Policy set definition ID, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionId?: string

Property Value

string

policySetDefinitionName

Policy set definition name, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionName?: string

Property Value

string

policySetDefinitionOwner

Policy set definition owner, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionOwner?: string

Property Value

string

policySetDefinitionParameters

Policy set definition parameters, if the policy assignment is for a policy set. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionParameters?: string

Property Value

string

policySetDefinitionVersion

Evaluated policy set definition version. NOTE: This property will not be serialized. It can only be populated by the server.

policySetDefinitionVersion?: string

Property Value

string

resourceGroup

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

resourceGroup?: string

Property Value

string

resourceId

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

resourceId?: string

Property Value

string

resourceLocation

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

resourceLocation?: string

Property Value

string

resourceType

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

resourceType?: string

Property Value

string

subscriptionId

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

subscriptionId?: string

Property Value

string

timestamp

Timestamp for the component policy state record. NOTE: This property will not be serialized. It can only be populated by the server.

timestamp?: Date

Property Value

Date