CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this OrgPolicyOverlay. The resources to scan are inferred from these specified changes.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: policysimulator1 --scope <scope> organizations locations-org-policy-violations-previews-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: organizations/my-example-org/locations/global

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview:
  create-time: string
  custom-constraints: [string]
  name: string
  resource-counts:
    compliant: integer
    errors: integer
    noncompliant: integer
    scanned: integer
    unenforced: integer
  state: string
  violations-count: integer

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . create-time=gubergren
    • Output only. Time when this OrgPolicyViolationsPreview was created.
  • custom-constraints=lorem
    • 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
    • Each invocation of this argument appends the given value to the array.
  • name=gubergren
    • 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
  • resource-counts compliant=26
    • Output only. Number of scanned resources with zero violations.
  • errors=97
    • Output only. Number of resources that returned an error when scanned.
  • noncompliant=84
    • Output only. Number of scanned resources with at least one violation.
  • scanned=46
    • Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error

  • unenforced=13

    • Output only. Number of resources where the constraint was not enforced, i.e. the Policy set enforced: false for that resource.

  • .. state=amet

    • Output only. The state of the OrgPolicyViolationsPreview.
  • violations-count=81
    • 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p org-policy-violations-preview-id=string
    • Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").