Update documentation

This commit is contained in:
Sebastian Thiel
2022-03-08 15:36:16 +08:00
parent b84384c010
commit a20241b241
10471 changed files with 1934132 additions and 64947 deletions

View File

@@ -5,7 +5,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Set Iam Policy - compute v2.0.4+20210316</title>
<title>Set Iam Policy - compute v3.0.0+20220224</title>
@@ -34,7 +34,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> compute v2.0.4+20210316</a>
<a href=".." class="icon icon-home"> compute v3.0.0+20220224</a>
</div>
@@ -172,6 +172,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-buckets_set-edge-security-policy">Set Edge Security Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-buckets_update">Update</a>
@@ -228,6 +233,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-services_set-edge-security-policy">Set Edge Security Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-services_set-security-policy">Set Security Policy</a>
@@ -852,6 +862,17 @@
<span>Image Family Views</span>
<li class="toctree-l1 ">
<a class="" href="../image-family-views_get">Get</a>
</li>
<span>Images</span>
<li class="toctree-l1 ">
@@ -1213,6 +1234,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_resume">Resume</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_send-diagnostic-interrupt">Send Diagnostic Interrupt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_set-deletion-protection">Set Deletion Protection</a>
@@ -1293,6 +1324,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_suspend">Suspend</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_test-iam-permissions">Test Iam Permissions</a>
@@ -1472,6 +1508,47 @@
<span>Machine Images</span>
<li class="toctree-l1 ">
<a class="" href="../machine-images_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Machine Types</span>
<li class="toctree-l1 ">
@@ -1544,6 +1621,92 @@
<span>Network Firewall Policies</span>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_add-association">Add Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_add-rule">Add Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_clone-rules">Clone Rules</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-association">Get Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-rule">Get Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_patch-rule">Patch Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_remove-association">Remove Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_remove-rule">Remove Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Networks</span>
<li class="toctree-l1 ">
@@ -2042,6 +2205,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../region-commitments_update">Update</a>
</li>
@@ -2359,6 +2527,97 @@
<span>Region Network Firewall Policies</span>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_add-association">Add Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_add-rule">Add Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_clone-rules">Clone Rules</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-association">Get Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-effective-firewalls">Get Effective Firewalls</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-rule">Get Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_patch-rule">Patch Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_remove-association">Remove Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_remove-rule">Remove Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Region Notification Endpoints</span>
<li class="toctree-l1 ">
@@ -2608,6 +2867,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../reservations_update">Update</a>
</li>
@@ -2796,6 +3060,57 @@
<span>Service Attachments</span>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_aggregated-list">Aggregated List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Snapshots</span>
<li class="toctree-l1 ">
@@ -2813,6 +3128,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../snapshots_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../snapshots_list">List</a>
@@ -3537,34 +3857,22 @@ In the latter case it is advised to set the field-cursor to the data-structure's
etag: string
policy:
etag: string
iam-owned: boolean
version: integer
</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 . etag=lorem</code><ul>
<li><code>-r . etag=et</code><ul>
<li>Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#39;policy&#39; to specify the etag.</li>
</ul>
</li>
<li><code>policy etag=elitr</code><ul>
<li>
<p><code>etag</code> is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the <code>etag</code> in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An <code>etag</code> is returned in the response to <code>getIamPolicy</code>, and systems are expected to put that etag in the request to <code>setIamPolicy</code> to ensure that their change will be applied to the same version of the policy.</p>
<p><strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost.
<em> <code>iam-owned=true</code>
-
</em> <code>version=75</code>
- Specifies the format of the policy.</p>
<p>Valid values are <code>0</code>, <code>1</code>, and <code>3</code>. Requests that specify an invalid value are rejected.</p>
<p>Any operation that affects conditional role bindings must specify version <code>3</code>. This requirement applies to the following operations:</p>
<ul>
<li>Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions</li>
<li><code>policy etag=dolores</code><ul>
<li><code>etag</code> is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the <code>etag</code> in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An <code>etag</code> is returned in the response to <code>getIamPolicy</code>, and systems are expected to put that etag in the request to <code>setIamPolicy</code> to ensure that their change will be applied to the same version of the policy. <strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost.</li>
</ul>
<p><strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost.</p>
<p>If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.</p>
<p>To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</p>
</li>
<li><code>version=82</code><ul>
<li>Specifies the format of the policy. Valid values are <code>0</code>, <code>1</code>, and <code>3</code>. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version <code>3</code>. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions <strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</li>
</ul>
</li>
</ul>
@@ -3591,9 +3899,27 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<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 the response.</li>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
@@ -3623,13 +3949,25 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
<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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
<li>Legacy name for parameter that has been superseded by <code>quotaUser</code>.</li>
</ul>
</li>
</ul>