PolicyState Class

Definition

Policy state record.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.PolicyStateTypeConverter))]
public class PolicyState : Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IPolicyState, Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Runtime.IAssociativeArray<object>
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.PolicyStateTypeConverter))>]
type PolicyState = class
    interface IPolicyState
    interface IJsonSerializable
    interface IAssociativeArray<obj>
Public Class PolicyState
Implements IAssociativeArray(Of Object), IPolicyState
Inheritance
PolicyState
Attributes
Implements

Constructors

Name Description
PolicyState()

Creates an new PolicyState instance.

Fields

Name Description
__additionalProperties

Properties

Name Description
ComplianceState

Compliance state of the resource.

Component

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

EffectiveParameter

Effective parameters for the policy assignment.

IfNotExistDetailResourceId

ID of the last evaluated resource for IfNotExists effect.

IfNotExistDetailTotalResource

Total number of resources to which the existence condition is applicable.

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.

Item[String]
ManagementGroupId

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.

PolicyAssignmentParameter

Policy assignment parameters.

PolicyAssignmentScope

Policy assignment scope.

PolicyAssignmentVersion

Evaluated policy assignment version.

PolicyDefinitionAction

Policy definition action, i.e. effect.

PolicyDefinitionCategory

Policy definition category.

PolicyDefinitionGroupName

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.

PolicyEvaluationDetailEvaluatedExpression

Details of the evaluated expressions.

PolicyEvaluationDetails

Gets the policy evaluation details for the queried resource.

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.

PolicySetDefinitionParameter

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.

ResourceTag

List of resource tags.

ResourceType

Resource type.

SubscriptionId

Subscription ID.

Timestamp

Timestamp for the policy state record.

Methods

Name Description
Add(String, Object)
Clear()
ContainsKey(String)
CopyFrom(IDictionary)
CopyFrom(PSObject)
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PolicyState.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PolicyState.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IPolicyState.

FromJsonString(String)

Creates a new instance of PolicyState, deserializing the content from a json string.

Remove(String)
ToJson(JsonObject, SerializationMode)

Serializes this instance of PolicyState into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
TryGetValue(String, Object)

Operators

Name Description
Implicit(PolicyState to Dictionary<String,Object>)

Explicit Interface Implementations

Name Description
IAssociativeArray<Object>.AdditionalProperties
IAssociativeArray<Object>.Count
IAssociativeArray<Object>.Keys
IAssociativeArray<Object>.Values

Applies to