Share via

PolicyState interface

  • Reference
Package:
@azure/arm-policyinsights

Policy state record.

Properties

complianceState

Compliance state of the resource.
components

Components state compliance records populated only when URL contains $expand=components clause.
effectiveParameters

Effective parameters for the policy assignment.
isCompliant

Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.
managementGroupIds

Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
odataContext

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

OData entity ID; always set to null since 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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
policyEvaluationDetails

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

Resource group name.
resourceId

Resource ID.
resourceLocation

Resource location.
resourceTags

List of resource tags.
resourceType

Resource type.
subscriptionId

Subscription ID.
timestamp

Timestamp for the policy state record.

Property Details

complianceState

Compliance state of the resource.

complianceState?: string

Property Value

string

components

Components state compliance records populated only when URL contains $expand=components clause.

components?: ComponentStateDetails[]

Property Value

ComponentStateDetails[]

effectiveParameters

Effective parameters for the policy assignment.

effectiveParameters?: string

Property Value

string

isCompliant

Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.

isCompliant?: boolean

Property Value

boolean

managementGroupIds

Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.

managementGroupIds?: 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 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. 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.

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

policyDefinitionVersion?: string

Property Value

string

policyEvaluationDetails

Policy evaluation details.

policyEvaluationDetails?: PolicyEvaluationDetails

Property Value

PolicyEvaluationDetails

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

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

resourceTags

List of resource tags.

resourceTags?: string

Property Value

string

resourceType

Resource type.

resourceType?: string

Property Value

string

subscriptionId

Subscription ID.

subscriptionId?: string

Property Value

string

timestamp

Timestamp for the policy state record.

timestamp?: Date

Property Value

Date