PolicyState Interface

Package:

com.azure.resourcemanager.policyinsights.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-policyinsights:1.0.0-beta.3

public interface PolicyState

An immutable client-side representation of PolicyState.

Method Summary

Modifier and Type	Method and Description
abstract Map<String,Object>	additionalProperties() Gets the additionalProperties property: Policy state record.
abstract String	complianceState() Gets the complianceState property: Compliance state of the resource.
abstract List<ComponentStateDetails>	components() Gets the components property: Components state compliance records populated only when URL contains $expand=components clause.
abstract String	effectiveParameters() Gets the effectiveParameters property: Effective parameters for the policy assignment.
abstract PolicyStateInner	innerModel() Gets the inner com.azure.resourcemanager.policyinsights.fluent.models.PolicyStateInner object.
abstract Boolean	isCompliant() Gets the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
abstract 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.
abstract String	odataContext() Gets the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.
abstract String	odataId() Gets the odataId property: OData entity ID; always set to null since policy state records do not have an entity ID.
abstract String	policyAssignmentId() Gets the policyAssignmentId property: Policy assignment ID.
abstract String	policyAssignmentName() Gets the policyAssignmentName property: Policy assignment name.
abstract String	policyAssignmentOwner() Gets the policyAssignmentOwner property: Policy assignment owner.
abstract String	policyAssignmentParameters() Gets the policyAssignmentParameters property: Policy assignment parameters.
abstract String	policyAssignmentScope() Gets the policyAssignmentScope property: Policy assignment scope.
abstract String	policyAssignmentVersion() Gets the policyAssignmentVersion property: Evaluated policy assignment version.
abstract String	policyDefinitionAction() Gets the policyDefinitionAction property: Policy definition action, i.e.
abstract String	policyDefinitionCategory() Gets the policyDefinitionCategory property: Policy definition category.
abstract List<String>	policyDefinitionGroupNames() Gets the policyDefinitionGroupNames property: Policy definition group names.
abstract String	policyDefinitionId() Gets the policyDefinitionId property: Policy definition ID.
abstract String	policyDefinitionName() Gets the policyDefinitionName property: Policy definition name.
abstract 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.
abstract String	policyDefinitionVersion() Gets the policyDefinitionVersion property: Evaluated policy definition version.
abstract PolicyEvaluationDetails	policyEvaluationDetails() Gets the policyEvaluationDetails property: Policy evaluation details.
abstract String	policySetDefinitionCategory() Gets the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.
abstract String	policySetDefinitionId() Gets the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.
abstract String	policySetDefinitionName() Gets the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.
abstract String	policySetDefinitionOwner() Gets the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.
abstract String	policySetDefinitionParameters() Gets the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.
abstract String	policySetDefinitionVersion() Gets the policySetDefinitionVersion property: Evaluated policy set definition version.
abstract String	resourceGroup() Gets the resourceGroup property: Resource group name.
abstract String	resourceId() Gets the resourceId property: Resource ID.
abstract String	resourceLocation() Gets the resourceLocation property: Resource location.
abstract String	resourceTags() Gets the resourceTags property: List of resource tags.
abstract String	resourceType() Gets the resourceType property: Resource type.
abstract String	subscriptionId() Gets the subscriptionId property: Subscription ID.
abstract OffsetDateTime	timestamp() Gets the timestamp property: Timestamp for the policy state record.

Method Details

additionalProperties

public abstract Map additionalProperties()

Gets the additionalProperties property: Policy state record.

Returns:

the additionalProperties value.

complianceState

public abstract String complianceState()

Gets the complianceState property: Compliance state of the resource.

Returns:

the complianceState value.

components

public abstract List components()

Gets the components property: Components state compliance records populated only when URL contains $expand=components clause.

Returns:

the components value.

effectiveParameters

public abstract String effectiveParameters()

Gets the effectiveParameters property: Effective parameters for the policy assignment.

Returns:

the effectiveParameters value.

innerModel

public abstract PolicyStateInner innerModel()

Gets the inner com.azure.resourcemanager.policyinsights.fluent.models.PolicyStateInner object.

Returns:

the inner object.

isCompliant

public abstract 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.

managementGroupIds

public abstract 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.

odataContext

public abstract String odataContext()

Gets the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.

Returns:

the odataContext value.

odataId

public abstract 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.

policyAssignmentId

public abstract String policyAssignmentId()

Gets the policyAssignmentId property: Policy assignment ID.

Returns:

the policyAssignmentId value.

policyAssignmentName

public abstract String policyAssignmentName()

Gets the policyAssignmentName property: Policy assignment name.

Returns:

the policyAssignmentName value.

policyAssignmentOwner

public abstract String policyAssignmentOwner()

Gets the policyAssignmentOwner property: Policy assignment owner.

Returns:

the policyAssignmentOwner value.

policyAssignmentParameters

public abstract String policyAssignmentParameters()

Gets the policyAssignmentParameters property: Policy assignment parameters.

Returns:

the policyAssignmentParameters value.

policyAssignmentScope

public abstract String policyAssignmentScope()

Gets the policyAssignmentScope property: Policy assignment scope.

Returns:

the policyAssignmentScope value.

policyAssignmentVersion

public abstract String policyAssignmentVersion()

Gets the policyAssignmentVersion property: Evaluated policy assignment version.

Returns:

the policyAssignmentVersion value.

policyDefinitionAction

public abstract String policyDefinitionAction()

Gets the policyDefinitionAction property: Policy definition action, i.e. effect.

Returns:

the policyDefinitionAction value.

policyDefinitionCategory

public abstract String policyDefinitionCategory()

Gets the policyDefinitionCategory property: Policy definition category.

Returns:

the policyDefinitionCategory value.

policyDefinitionGroupNames

public abstract List policyDefinitionGroupNames()

Gets the policyDefinitionGroupNames property: Policy definition group names.

Returns:

the policyDefinitionGroupNames value.

policyDefinitionId

public abstract String policyDefinitionId()

Gets the policyDefinitionId property: Policy definition ID.

Returns:

the policyDefinitionId value.

policyDefinitionName

public abstract String policyDefinitionName()

Gets the policyDefinitionName property: Policy definition name.

Returns:

the policyDefinitionName value.

policyDefinitionReferenceId

public abstract 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.

policyDefinitionVersion

public abstract String policyDefinitionVersion()

Gets the policyDefinitionVersion property: Evaluated policy definition version.

Returns:

the policyDefinitionVersion value.

policyEvaluationDetails

public abstract PolicyEvaluationDetails policyEvaluationDetails()

Gets the policyEvaluationDetails property: Policy evaluation details.

Returns:

the policyEvaluationDetails value.

policySetDefinitionCategory

public abstract String policySetDefinitionCategory()

Gets the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionCategory value.

policySetDefinitionId

public abstract String policySetDefinitionId()

Gets the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionId value.

policySetDefinitionName

public abstract String policySetDefinitionName()

Gets the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionName value.

policySetDefinitionOwner

public abstract String policySetDefinitionOwner()

Gets the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionOwner value.

policySetDefinitionParameters

public abstract String policySetDefinitionParameters()

Gets the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionParameters value.

policySetDefinitionVersion

public abstract String policySetDefinitionVersion()

Gets the policySetDefinitionVersion property: Evaluated policy set definition version.

Returns:

the policySetDefinitionVersion value.

resourceGroup

public abstract String resourceGroup()

Gets the resourceGroup property: Resource group name.

Returns:

the resourceGroup value.

resourceId

public abstract String resourceId()

Gets the resourceId property: Resource ID.

Returns:

the resourceId value.

resourceLocation

public abstract String resourceLocation()

Gets the resourceLocation property: Resource location.

Returns:

the resourceLocation value.

resourceTags

public abstract String resourceTags()

Gets the resourceTags property: List of resource tags.

Returns:

the resourceTags value.

resourceType

public abstract String resourceType()

Gets the resourceType property: Resource type.

Returns:

the resourceType value.

subscriptionId

public abstract String subscriptionId()

Gets the subscriptionId property: Subscription ID.

Returns:

the subscriptionId value.

timestamp

public abstract OffsetDateTime timestamp()

Gets the timestamp property: Timestamp for the policy state record.

Returns:

the timestamp value.