GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview

import type { GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview } from "https://googleapis.deno.dev/v1/policysimulator:v1.ts";

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.

interface GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview {

readonly createTime?: Date;

readonly customConstraints?: string[];

readonly name?: string;

overlay?: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay;

readonly resourceCounts?: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts;

readonly state?:

| "PREVIEW_STATE_UNSPECIFIED"

| "PREVIEW_PENDING"

| "PREVIEW_RUNNING"

| "PREVIEW_SUCCEEDED"

| "PREVIEW_FAILED";

readonly violationsCount?: number;

}

§Properties

readonly createTime?: Date

[src]

Output only. Time when this OrgPolicyViolationsPreview was created.

readonly customConstraints?: string[]

[src]

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

readonly name?: string

[src]

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

overlay?: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay

[src]

Required. The proposed changes we are previewing violations for.

readonly resourceCounts?: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts

[src]

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

readonly state?: "PREVIEW_STATE_UNSPECIFIED" | "PREVIEW_PENDING" | "PREVIEW_RUNNING" | "PREVIEW_SUCCEEDED" | "PREVIEW_FAILED"

[src]

Output only. The state of the OrgPolicyViolationsPreview.

readonly violationsCount?: number

[src]

Output only. The number of OrgPolicyViolations in this OrgPolicyViolationsPreview. This count may differ from resource_summary.noncompliant_count because each 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.