ListAvailableOrgPolicyConstraintsResponse

The response returned from the [projects.listAvailableOrgPolicyConstraints] [google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method. Returns all Constraints that could be set at this level of the hierarchy (contrast with the response from ListPolicies, which returns all policies which are set).

JSON representation
{
  "constraints": [
    {
      object(Constraint)
    }
  ],
  "nextPageToken": string
}
Fields
constraints[]

object(Constraint)

The collection of constraints that are settable on the request resource.

nextPageToken

string

Page token used to retrieve the next page. This is currently not used.

Constraint

A Constraint describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization's policy adminstrator to fit the needs of the organzation by setting Policies for Constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about [Policies][google.cloud.OrgPolicy.v1.Policy].

Constraints have a default behavior determined by the constraintDefault field, which is the enforcement behavior that is used in the absence of a Policy being defined or inherited for the resource in question.

JSON representation
{
  "version": number,
  "name": string,
  "displayName": string,
  "description": string,
  "constraintDefault": enum(ConstraintDefault),

  // Union field constraint_type can be only one of the following:
  "listConstraint": {
    object(ListConstraint)
  },
  "booleanConstraint": {
    object(BooleanConstraint)
  }
  // End of list of possible types for union field constraint_type.
}
Fields
version

number

Version of the Constraint. Default version is 0;

name

string

Immutable value, required to globally be unique. For example, constraints/serviceuser.services

displayName

string

The human readable name.

Mutable.

description

string

Detailed description of what this Constraint controls as well as how and where it is enforced.

Mutable.

constraintDefault

enum(ConstraintDefault)

The evaluation behavior of this constraint in the absense of 'Policy'.

Union field constraint_type. The type of restrictions for this Constraint.

Immutable after creation. constraint_type can be only one of the following:

listConstraint

object(ListConstraint)

Defines this constraint as being a ListConstraint.

booleanConstraint

object(BooleanConstraint)

Defines this constraint as being a BooleanConstraint.

ConstraintDefault

Specifies the default behavior in the absence of any Policy for the Constraint. This must not be CONSTRAINT_DEFAULT_UNSPECIFIED.

Immutable after creation.

Enums
CONSTRAINT_DEFAULT_UNSPECIFIED This is only used for distinguishing unset values and should never be used.
ALLOW Indicate that all values are allowed for list constraints. Indicate that enforcement is off for boolean constraints.
DENY Indicate that all values are denied for list constraints. Indicate that enforcement is on for boolean constraints.

ListConstraint

A Constraint that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a Policy.

JSON representation
{
  "suggestedValue": string,
  "supportsUnder": boolean
}
Fields
suggestedValue

string

Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this Constraint.

supportsUnder

boolean

Indicates whether subtrees of Cloud Resource Manager resource hierarchy can be used in Policy.allowed_values and Policy.denied_values. For example, "under:folders/123" would match any resource under the 'folders/123' folder.

BooleanConstraint

A Constraint that is either enforced or not.

For example a constraint constraints/compute.disableSerialPortAccess. If it is enforced on a VM instance, serial port connections will not be opened to that instance.

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...