Policy Simulator v1 API - Class OrgPolicyViolationsPreview (1.3.0)

Reference documentation and code samples for the Policy Simulator v1 API class OrgPolicyViolationsPreview.

OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made.

The list of violations are modeled as child resources and retrieved via a [ListOrgPolicyViolations][] API call. There are potentially more [OrgPolicyViolations][] than could fit in an embedded field. Thus, the use of a child resource instead of a field.

Output only. Time when this OrgPolicyViolationsPreview was created.

Output only. The names of the constraints against which all OrgPolicyViolations were evaluated.

If OrgPolicyOverlay only contains PolicyOverlay then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in CustomConstraintOverlay.

Format: organizations/{organization_id}/customConstraints/{custom_constraint_id}

Example: organizations/123/customConstraints/custom.createOnlyE2TypeVms

CustomConstraintName-typed view over the CustomConstraints resource name property.

Output only. The resource name of the OrgPolicyViolationsPreview. It has the following format:

organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}

Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f

OrgPolicyViolationsPreviewName-typed view over the Name resource name property.

Required. The proposed changes we are previewing violations for.

Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.

Output only. The state of the OrgPolicyViolationsPreview.

Output only. The number of [OrgPolicyViolations][] in this OrgPolicyViolationsPreview. This count may differ from resource_summary.noncompliant_count because each [OrgPolicyViolation][google.cloud.policysimulator.v1.OrgPolicyViolation] is specific to a resource and constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.