The response returned from the projects.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 ( |
Fields | |
---|---|
constraints[] |
The collection of constraints that are settable on the request resource. |
nextPageToken |
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 administrator 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.
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": integer, "name": string, "displayName": string, "description": string, "constraintDefault": enum ( |
Fields | |
---|---|
version |
Version of the |
name |
Immutable value, required to globally be unique. For example, |
displayName |
The human readable name. Mutable. |
description |
Detailed description of what this Mutable. |
constraintDefault |
The evaluation behavior of this constraint in the absence of 'Policy'. |
Union field Immutable after creation. |
|
listConstraint |
Defines this constraint as being a ListConstraint. |
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 |
Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this |
supportsUnder |
Indicates whether subtrees of Cloud Resource Manager resource hierarchy can be used in |
BooleanConstraint
This type has no fields.
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.