Interface PolicyState
public interface PolicyState
An immutable client-side representation of PolicyState.
-
Method Summary
Modifier and TypeMethodDescriptionGets the additionalProperties property: Policy state record.Gets the complianceState property: Compliance state of the resource.Gets the components property: Components state compliance records populated only when URL contains $expand=components clause.Gets the effectiveParameters property: Effective parameters for the policy assignment.Gets the inner com.azure.resourcemanager.policyinsights.fluent.models.PolicyStateInner object.Gets the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against.Gets the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.Gets the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.odataId()
Gets the odataId property: OData entity ID; always set to null since policy state records do not have an entity ID.Gets the policyAssignmentId property: Policy assignment ID.Gets the policyAssignmentName property: Policy assignment name.Gets the policyAssignmentOwner property: Policy assignment owner.Gets the policyAssignmentParameters property: Policy assignment parameters.Gets the policyAssignmentScope property: Policy assignment scope.Gets the policyAssignmentVersion property: Evaluated policy assignment version.Gets the policyDefinitionAction property: Policy definition action, i.e.Gets the policyDefinitionCategory property: Policy definition category.Gets the policyDefinitionGroupNames property: Policy definition group names.Gets the policyDefinitionId property: Policy definition ID.Gets the policyDefinitionName property: Policy definition name.Gets the policyDefinitionReferenceId property: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.Gets the policyDefinitionVersion property: Evaluated policy definition version.Gets the policyEvaluationDetails property: Policy evaluation details.Gets the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.Gets the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.Gets the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.Gets the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.Gets the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.Gets the policySetDefinitionVersion property: Evaluated policy set definition version.Gets the resourceGroup property: Resource group name.Gets the resourceId property: Resource ID.Gets the resourceLocation property: Resource location.Gets the resourceTags property: List of resource tags.Gets the resourceType property: Resource type.Gets the subscriptionId property: Subscription ID.Gets the timestamp property: Timestamp for the policy state record.
-
Method Details
-
odataId
String odataId()Gets the odataId property: OData entity ID; always set to null since policy state records do not have an entity ID.- Returns:
- the odataId value.
-
odataContext
String odataContext()Gets the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.- Returns:
- the odataContext value.
-
timestamp
OffsetDateTime timestamp()Gets the timestamp property: Timestamp for the policy state record.- Returns:
- the timestamp value.
-
resourceId
String resourceId()Gets the resourceId property: Resource ID.- Returns:
- the resourceId value.
-
policyAssignmentId
String policyAssignmentId()Gets the policyAssignmentId property: Policy assignment ID.- Returns:
- the policyAssignmentId value.
-
policyDefinitionId
String policyDefinitionId()Gets the policyDefinitionId property: Policy definition ID.- Returns:
- the policyDefinitionId value.
-
effectiveParameters
String effectiveParameters()Gets the effectiveParameters property: Effective parameters for the policy assignment.- Returns:
- the effectiveParameters value.
-
isCompliant
Boolean isCompliant()Gets the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.- Returns:
- the isCompliant value.
-
subscriptionId
String subscriptionId()Gets the subscriptionId property: Subscription ID.- Returns:
- the subscriptionId value.
-
resourceType
String resourceType()Gets the resourceType property: Resource type.- Returns:
- the resourceType value.
-
resourceLocation
String resourceLocation()Gets the resourceLocation property: Resource location.- Returns:
- the resourceLocation value.
-
resourceGroup
String resourceGroup()Gets the resourceGroup property: Resource group name.- Returns:
- the resourceGroup value.
-
resourceTags
String resourceTags()Gets the resourceTags property: List of resource tags.- Returns:
- the resourceTags value.
-
policyAssignmentName
String policyAssignmentName()Gets the policyAssignmentName property: Policy assignment name.- Returns:
- the policyAssignmentName value.
-
policyAssignmentOwner
String policyAssignmentOwner()Gets the policyAssignmentOwner property: Policy assignment owner.- Returns:
- the policyAssignmentOwner value.
-
policyAssignmentParameters
String policyAssignmentParameters()Gets the policyAssignmentParameters property: Policy assignment parameters.- Returns:
- the policyAssignmentParameters value.
-
policyAssignmentScope
String policyAssignmentScope()Gets the policyAssignmentScope property: Policy assignment scope.- Returns:
- the policyAssignmentScope value.
-
policyDefinitionName
String policyDefinitionName()Gets the policyDefinitionName property: Policy definition name.- Returns:
- the policyDefinitionName value.
-
policyDefinitionAction
String policyDefinitionAction()Gets the policyDefinitionAction property: Policy definition action, i.e. effect.- Returns:
- the policyDefinitionAction value.
-
policyDefinitionCategory
String policyDefinitionCategory()Gets the policyDefinitionCategory property: Policy definition category.- Returns:
- the policyDefinitionCategory value.
-
policySetDefinitionId
String policySetDefinitionId()Gets the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.- Returns:
- the policySetDefinitionId value.
-
policySetDefinitionName
String policySetDefinitionName()Gets the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.- Returns:
- the policySetDefinitionName value.
-
policySetDefinitionOwner
String policySetDefinitionOwner()Gets the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.- Returns:
- the policySetDefinitionOwner value.
-
policySetDefinitionCategory
String policySetDefinitionCategory()Gets the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.- Returns:
- the policySetDefinitionCategory value.
-
policySetDefinitionParameters
String policySetDefinitionParameters()Gets the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.- Returns:
- the policySetDefinitionParameters value.
-
managementGroupIds
String managementGroupIds()Gets the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.- Returns:
- the managementGroupIds value.
-
policyDefinitionReferenceId
String policyDefinitionReferenceId()Gets the policyDefinitionReferenceId property: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.- Returns:
- the policyDefinitionReferenceId value.
-
complianceState
String complianceState()Gets the complianceState property: Compliance state of the resource.- Returns:
- the complianceState value.
-
policyEvaluationDetails
PolicyEvaluationDetails policyEvaluationDetails()Gets the policyEvaluationDetails property: Policy evaluation details.- Returns:
- the policyEvaluationDetails value.
-
policyDefinitionGroupNames
Gets the policyDefinitionGroupNames property: Policy definition group names.- Returns:
- the policyDefinitionGroupNames value.
-
components
List<ComponentStateDetails> components()Gets the components property: Components state compliance records populated only when URL contains $expand=components clause.- Returns:
- the components value.
-
policyDefinitionVersion
String policyDefinitionVersion()Gets the policyDefinitionVersion property: Evaluated policy definition version.- Returns:
- the policyDefinitionVersion value.
-
policySetDefinitionVersion
String policySetDefinitionVersion()Gets the policySetDefinitionVersion property: Evaluated policy set definition version.- Returns:
- the policySetDefinitionVersion value.
-
policyAssignmentVersion
String policyAssignmentVersion()Gets the policyAssignmentVersion property: Evaluated policy assignment version.- Returns:
- the policyAssignmentVersion value.
-
additionalProperties
Gets the additionalProperties property: Policy state record.- Returns:
- the additionalProperties value.
-
innerModel
PolicyStateInner innerModel()Gets the inner com.azure.resourcemanager.policyinsights.fluent.models.PolicyStateInner object.- Returns:
- the inner object.
-