Share via


PolicyState Class

Definition

Policy state record.

public class PolicyState
type PolicyState = class
Public Class PolicyState
Inheritance
PolicyState

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

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.

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.

ResourceTags

List of resource tags.

ResourceTypeString

Resource type.

SubscriptionId

Subscription ID.

Timestamp

Timestamp for the policy state record.

Applies to