REST Resource: organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations

Resource: OrgPolicyViolation

OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint.

JSON representation 
{
  "name": string,
  "resource": {
    object (ResourceContext)
  },
  "customConstraint": {
    object (CustomConstraint)
  },
  "error": {
    object (Status)
  }
}
Fields
name

string

The name of the OrgPolicyViolation. Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce`
resource

object (ResourceContext)

The resource violating the constraint.
customConstraint

object (CustomConstraint)

The custom constraint being violated.
error

object (Status)

Any error encountered during the evaluation.

ResourceContext

ResourceContext provides the context we know about a resource. It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator.

JSON representation 
{
  "resource": string,
  "assetType": string,
  "ancestors": [
    string
  ]
}
Fields
resource

string

The full name of the resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1

See Resource names for more information.
assetType

string

The asset type of the resource as defined by CAIS.

Example: compute.googleapis.com/Firewall

See Supported asset types for more information.
ancestors[]

string

The ancestry path of the resource in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Methods

list

 ListOrgPolicyViolations lists the [OrgPolicyViolations][] that are present in an OrgPolicyViolationsPreview.