mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
393 lines
21 KiB
HTML
393 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-orgpolicy2-cli/projects_policies-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Policies Patch - OrgPolicy API v5.0.4+20240226</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Policies Patch";
|
|
var mkdocs_page_input_path = "projects_policies-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-orgpolicy2-cli/projects_policies-patch/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> OrgPolicy API v5.0.4+20240226
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Folders</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_constraints-list/">Constraints List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-create/">Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-delete/">Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-get/">Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-get-effective-policy/">Policies Get Effective Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-list/">Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_policies-patch/">Policies Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Organizations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_constraints-list/">Constraints List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_custom-constraints-create/">Custom Constraints Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_custom-constraints-delete/">Custom Constraints Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_custom-constraints-get/">Custom Constraints Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_custom-constraints-list/">Custom Constraints List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_custom-constraints-patch/">Custom Constraints Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-create/">Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-delete/">Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-get/">Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-get-effective-policy/">Policies Get Effective Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-list/">Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_policies-patch/">Policies Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_constraints-list/">Constraints List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_policies-create/">Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_policies-delete/">Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_policies-get/">Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_policies-get-effective-policy/">Policies Get Effective Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_policies-list/">Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Policies Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">OrgPolicy API v5.0.4+20240226</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Policies Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/orgpolicy2-cli/edit/master/docs/projects_policies-patch.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Updates a policy. Returns a <code>google.rpc.Status</code> with <code>google.rpc.Code.NOT_FOUND</code> if the constraint or the policy do not exist. Returns a <code>google.rpc.Status</code> with <code>google.rpc.Code.ABORTED</code> 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.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>orgpolicy2 --scope <scope> projects policies-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Immutable. The resource name of the policy. Must be one of the following forms, where <code>constraint_name</code> is the name of the constraint which this policy configures: * <code>projects/{project_number}/policies/{constraint_name}</code> * <code>folders/{folder_id}/policies/{constraint_name}</code> * <code>organizations/{organization_id}/policies/{constraint_name}</code> For example, <code>projects/123/policies/compute.disableSerialPortAccess</code>. Note: <code>projects/{project_id}/policies/{constraint_name}</code> is also an acceptable name for API requests, but responses will return the name using the equivalent project number.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>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.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>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
|
|
|
|
</code></pre>
|
|
<p>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.</p>
|
|
<ul>
|
|
<li><code>-r .alternate launch=nonumy</code><ul>
|
|
<li>Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>spec etag=at</code><ul>
|
|
<li>An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a <code>CreatePolicy</code> request. When the policy is returned from either a <code>GetPolicy</code> or a <code>ListPolicies</code> request, this <code>etag</code> indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a <code>GetEffectivePolicy</code> request, the <code>etag</code> will be unset.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>inherit-from-parent=true</code><ul>
|
|
<li>Determines the inheritance behavior for this policy. If <code>inherit_from_parent</code> 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reset=true</code><ul>
|
|
<li>Ignores policies set above this resource and restores the <code>constraint_default</code> enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, <code>rules</code> must be empty and <code>inherit_from_parent</code> must be set to false.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>update-time=sadipscing</code></p>
|
|
<ul>
|
|
<li>Output only. The time stamp this was previously updated. This represents the last time a call to <code>CreatePolicy</code> or <code>UpdatePolicy</code> was made for that policy.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...dry-run-spec etag=erat</code></p>
|
|
<ul>
|
|
<li>An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a <code>CreatePolicy</code> request. When the policy is returned from either a <code>GetPolicy</code> or a <code>ListPolicies</code> request, this <code>etag</code> indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a <code>GetEffectivePolicy</code> request, the <code>etag</code> will be unset.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>inherit-from-parent=false</code><ul>
|
|
<li>Determines the inheritance behavior for this policy. If <code>inherit_from_parent</code> 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reset=true</code><ul>
|
|
<li>Ignores policies set above this resource and restores the <code>constraint_default</code> enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, <code>rules</code> must be empty and <code>inherit_from_parent</code> must be set to false.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>update-time=est</code></p>
|
|
<ul>
|
|
<li>Output only. The time stamp this was previously updated. This represents the last time a call to <code>CreatePolicy</code> or <code>UpdatePolicy</code> was made for that policy.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. etag=et</code></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sea</code><ul>
|
|
<li>Immutable. The resource name of the policy. Must be one of the following forms, where <code>constraint_name</code> is the name of the constraint which this policy configures: * <code>projects/{project_number}/policies/{constraint_name}</code> * <code>folders/{folder_id}/policies/{constraint_name}</code> * <code>organizations/{organization_id}/policies/{constraint_name}</code> For example, <code>projects/123/policies/compute.disableSerialPortAccess</code>. Note: <code>projects/{project_id}/policies/{constraint_name}</code> is also an acceptable name for API requests, but responses will return the name using the equivalent project number.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>spec etag=consetetur</code><ul>
|
|
<li>An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a <code>CreatePolicy</code> request. When the policy is returned from either a <code>GetPolicy</code> or a <code>ListPolicies</code> request, this <code>etag</code> indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a <code>GetEffectivePolicy</code> request, the <code>etag</code> will be unset.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>inherit-from-parent=true</code><ul>
|
|
<li>Determines the inheritance behavior for this policy. If <code>inherit_from_parent</code> 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reset=true</code><ul>
|
|
<li>Ignores policies set above this resource and restores the <code>constraint_default</code> enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, <code>rules</code> must be empty and <code>inherit_from_parent</code> must be set to false.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=est</code><ul>
|
|
<li>Output only. The time stamp this was previously updated. This represents the last time a call to <code>CreatePolicy</code> or <code>UpdatePolicy</code> was made for that policy.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>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 <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_policies-list/" class="btn btn-neutral float-left" title="Policies List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/orgpolicy2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_policies-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|