ComponentPolicyState interface

Package:
@azure/arm-policyinsights

Component Policy State record.

Properties

additionalProperties

Additional properties
complianceState

Compliance state of the resource.
componentId

Component Id.
componentName

Component name.
componentType

Component type.
odataContext

OData context string; used by OData clients to resolve type information based on metadata.
odataId

OData entity ID; always set to null since component policy state records do not have an entity ID.
policyAssignmentId

Policy assignment ID.
policyAssignmentName

Policy assignment name.
policyAssignmentOwner

Policy assignment owner.
policyAssignmentParameters

Policy assignment parameters.
policyAssignmentScope

Policy assignment scope.
policyAssignmentVersion

Evaluated policy assignment version.
policyDefinitionAction

Policy definition action, i.e. effect.
policyDefinitionCategory

Policy definition category.
policyDefinitionGroupNames

Policy definition group names.
policyDefinitionId

Policy definition ID.
policyDefinitionName

Policy definition name.
policyDefinitionReferenceId

Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
policyDefinitionVersion

Evaluated policy definition version.
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.
policySetDefinitionId

Policy set definition ID, if the policy assignment is for a policy set.
policySetDefinitionName

Policy set definition name, if the policy assignment is for a policy set.
policySetDefinitionOwner

Policy set definition owner, if the policy assignment is for a policy set.
policySetDefinitionParameters

Policy set definition parameters, if the policy assignment is for a policy set.
policySetDefinitionVersion

Evaluated policy set definition version.
resourceGroup

Resource group name.
resourceId

Resource ID.
resourceLocation

Resource location.
resourceType

Resource type.
subscriptionId

Subscription ID.
timestamp

Timestamp for the component policy state record.

Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, Record<string, unknown>>

Property Value

Record<string, Record<string, unknown>>

complianceState

Compliance state of the resource.

complianceState?: string

Property Value

string

componentId

Component Id.

componentId?: string

Property Value

string

componentName

Component name.

componentName?: string

Property Value

string

componentType

Component type.

componentType?: string

Property Value

string

odataContext

OData context string; used by OData clients to resolve type information based on metadata.

odataContext?: string

Property Value

string

odataId

OData entity ID; always set to null since component policy state records do not have an entity ID.

odataId?: string

Property Value

string

policyAssignmentId

Policy assignment ID.

policyAssignmentId?: string

Property Value

string

policyAssignmentName

Policy assignment name.

policyAssignmentName?: string

Property Value

string

policyAssignmentOwner

Policy assignment owner.

policyAssignmentOwner?: string

Property Value

string

policyAssignmentParameters

Policy assignment parameters.

policyAssignmentParameters?: string

Property Value

string

policyAssignmentScope

Policy assignment scope.

policyAssignmentScope?: string

Property Value

string

policyAssignmentVersion

Evaluated policy assignment version.

policyAssignmentVersion?: string

Property Value

string

policyDefinitionAction

Policy definition action, i.e. effect.

policyDefinitionAction?: string

Property Value

string

policyDefinitionCategory

Policy definition category.

policyDefinitionCategory?: string

Property Value

string

policyDefinitionGroupNames

Policy definition group names.

policyDefinitionGroupNames?: string[]

Property Value

string[]

policyDefinitionId

Policy definition ID.

policyDefinitionId?: string

Property Value

string

policyDefinitionName

Policy definition name.

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.

policyDefinitionReferenceId?: string

Property Value

string

policyDefinitionVersion

Evaluated policy definition version.

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.

policySetDefinitionCategory?: string

Property Value

string

policySetDefinitionId

Policy set definition ID, if the policy assignment is for a policy set.

policySetDefinitionId?: string

Property Value

string

policySetDefinitionName

Policy set definition name, if the policy assignment is for a policy set.

policySetDefinitionName?: string

Property Value

string

policySetDefinitionOwner

Policy set definition owner, if the policy assignment is for a policy set.

policySetDefinitionOwner?: string

Property Value

string

policySetDefinitionParameters

Policy set definition parameters, if the policy assignment is for a policy set.

policySetDefinitionParameters?: string

Property Value

string

policySetDefinitionVersion

Evaluated policy set definition version.

policySetDefinitionVersion?: string

Property Value

string

resourceGroup

Resource group name.

resourceGroup?: string

Property Value

string

resourceId

Resource ID.

resourceId?: string

Property Value

string

resourceLocation

Resource location.

resourceLocation?: string

Property Value

string

resourceType

Resource type.

resourceType?: string

Property Value

string

subscriptionId

Subscription ID.

subscriptionId?: string

Property Value

string

timestamp

Timestamp for the component policy state record.

timestamp?: Date

Property Value

Date