Updates a policy. Returns a google.rpc.Status
with google.rpc.Code.NOT_FOUND
if the constraint or the policy do not exist. Returns a google.rpc.Status
with google.rpc.Code.ABORTED
if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.
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: orgpolicy2 --scope <scope> projects policies-patch ...
Required Scalar Argument
- <name> (string)
- Immutable. The resource name of the policy. Must be one of the following forms, where
constraint_name
is the name of the constraint which this policy configures: *projects/{project_number}/policies/{constraint_name}
*folders/{folder_id}/policies/{constraint_name}
*organizations/{organization_id}/policies/{constraint_name}
For example,projects/123/policies/compute.disableSerialPortAccess
. Note:projects/{project_id}/policies/{constraint_name}
is also an acceptable name for API requests, but responses will return the name using the equivalent project number.
- Immutable. The resource name of the policy. Must be one of the following forms, where
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:
GoogleCloudOrgpolicyV2Policy:
alternate:
launch: string
spec:
etag: string
inherit-from-parent: boolean
reset: boolean
update-time: string
dry-run-spec:
etag: string
inherit-from-parent: boolean
reset: boolean
update-time: string
etag: string
name: string
spec:
etag: string
inherit-from-parent: boolean
reset: boolean
update-time: string
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 .alternate launch=nonumy
- Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.
spec etag=at
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
CreatePolicy
request. When the policy is returned from either aGetPolicy
or aListPolicies
request, thisetag
indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from aGetEffectivePolicy
request, theetag
will be unset.
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
inherit-from-parent=true
- Determines the inheritance behavior for this policy. If
inherit_from_parent
is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
- Determines the inheritance behavior for this policy. If
reset=true
- Ignores policies set above this resource and restores the
constraint_default
enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set,rules
must be empty andinherit_from_parent
must be set to false.
- Ignores policies set above this resource and restores the
-
update-time=sadipscing
- Output only. The time stamp this was previously updated. This represents the last time a call to
CreatePolicy
orUpdatePolicy
was made for that policy.
- Output only. The time stamp this was previously updated. This represents the last time a call to
-
...dry-run-spec etag=erat
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
CreatePolicy
request. When the policy is returned from either aGetPolicy
or aListPolicies
request, thisetag
indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from aGetEffectivePolicy
request, theetag
will be unset.
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
inherit-from-parent=false
- Determines the inheritance behavior for this policy. If
inherit_from_parent
is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
- Determines the inheritance behavior for this policy. If
reset=true
- Ignores policies set above this resource and restores the
constraint_default
enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set,rules
must be empty andinherit_from_parent
must be set to false.
- Ignores policies set above this resource and restores the
-
update-time=est
- Output only. The time stamp this was previously updated. This represents the last time a call to
CreatePolicy
orUpdatePolicy
was made for that policy.
- Output only. The time stamp this was previously updated. This represents the last time a call to
-
.. etag=et
- Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
name=sea
- Immutable. The resource name of the policy. Must be one of the following forms, where
constraint_name
is the name of the constraint which this policy configures: *projects/{project_number}/policies/{constraint_name}
*folders/{folder_id}/policies/{constraint_name}
*organizations/{organization_id}/policies/{constraint_name}
For example,projects/123/policies/compute.disableSerialPortAccess
. Note:projects/{project_id}/policies/{constraint_name}
is also an acceptable name for API requests, but responses will return the name using the equivalent project number.
- Immutable. The resource name of the policy. Must be one of the following forms, where
spec etag=consetetur
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
CreatePolicy
request. When the policy is returned from either aGetPolicy
or aListPolicies
request, thisetag
indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from aGetEffectivePolicy
request, theetag
will be unset.
- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a
inherit-from-parent=true
- Determines the inheritance behavior for this policy. If
inherit_from_parent
is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.
- Determines the inheritance behavior for this policy. If
reset=true
- Ignores policies set above this resource and restores the
constraint_default
enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set,rules
must be empty andinherit_from_parent
must be set to false.
- Ignores policies set above this resource and restores the
update-time=est
- Output only. The time stamp this was previously updated. This represents the last time a call to
CreatePolicy
orUpdatePolicy
was made for that policy.
- Output only. The time stamp this was previously updated. This represents the last time a call to
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.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
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 update-mask=string
- Field mask used to specify the fields to be overwritten in the policy by the set. The fields specified in the update_mask are relative to the policy, not the full request.
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").