REST Resource: organizations.locations.workloads.violations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Violation

Workload monitoring Violation.

JSON representation
{
  "name": string,
  "description": string,
  "beginTime": string,
  "updateTime": string,
  "resolveTime": string,
  "category": string,
  "state": enum (State),
  "orgPolicyConstraint": string,
  "auditLogLink": string,
  "nonCompliantOrgPolicy": string
}
Fields
name

string

Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}

description

string

Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.

beginTime

string (Timestamp format)

Output only. Time of the event which triggered the Violation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The last time when the Violation record was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

resolveTime

string (Timestamp format)

Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

category

string

Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.

state

enum (State)

Output only. State of the violation

orgPolicyConstraint

string

Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.

nonCompliantOrgPolicy

string

Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}

State

Violation State Values

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE Violation currently active.
RESOLVED Violation is resolved.
UNRESOLVED Violation is Unresolved
EXCEPTION Violation is Exception

Methods

get

Retrieves Assured Workload Violation based on ID.

list

Lists the Violations in the AssuredWorkload Environment.