mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
366 lines
21 KiB
HTML
366 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-bigtableadmin2-cli/projects_instances-set-iam-policy/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Instances Set Iam Policy - Bigtable Admin v5.0.4+20240221</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 = "Instances Set Iam Policy";
|
|
var mkdocs_page_input_path = "projects_instances-set-iam-policy.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-bigtableadmin2-cli/projects_instances-set-iam-policy/";
|
|
</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"> Bigtable Admin v5.0.4+20240221
|
|
</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">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_projects-operations-list/">Projects Operations List</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_instances-app-profiles-create/">Instances App Profiles Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-delete/">Instances App Profiles Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-get/">Instances App Profiles Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-list/">Instances App Profiles List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-patch/">Instances App Profiles Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-copy/">Instances Clusters Backups Copy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-create/">Instances Clusters Backups Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-delete/">Instances Clusters Backups Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-get/">Instances Clusters Backups Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-get-iam-policy/">Instances Clusters Backups Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-list/">Instances Clusters Backups List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-patch/">Instances Clusters Backups Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-set-iam-policy/">Instances Clusters Backups Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-test-iam-permissions/">Instances Clusters Backups Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-create/">Instances Clusters Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-delete/">Instances Clusters Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-get/">Instances Clusters Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-hot-tablets-list/">Instances Clusters Hot Tablets List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-list/">Instances Clusters List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-partial-update-cluster/">Instances Clusters Partial Update Cluster</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-update/">Instances Clusters Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-create/">Instances Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-delete/">Instances Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-get/">Instances Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-get-iam-policy/">Instances Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-list/">Instances List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-partial-update-instance/">Instances Partial Update Instance</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Instances Set Iam Policy</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-check-consistency/">Instances Tables Check Consistency</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-create/">Instances Tables Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-delete/">Instances Tables Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-drop-row-range/">Instances Tables Drop Row Range</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-generate-consistency-token/">Instances Tables Generate Consistency Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-get/">Instances Tables Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-get-iam-policy/">Instances Tables Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-list/">Instances Tables List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-modify-column-families/">Instances Tables Modify Column Families</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-patch/">Instances Tables Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-restore/">Instances Tables Restore</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-set-iam-policy/">Instances Tables Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-test-iam-permissions/">Instances Tables Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-undelete/">Instances Tables Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-test-iam-permissions/">Instances Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-update/">Instances Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
|
|
</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="..">Bigtable Admin v5.0.4+20240221</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>Instances Set Iam Policy</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigtableadmin2-cli/edit/master/docs/projects_instances-set-iam-policy.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>Sets the access control policy on an instance resource. Replaces any existing policy.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/bigtable.admin</em></li>
|
|
<li><em>https://www.googleapis.com/auth/bigtable.admin.cluster</em></li>
|
|
<li><em>https://www.googleapis.com/auth/bigtable.admin.instance</em></li>
|
|
<li><em>https://www.googleapis.com/auth/cloud-bigtable.admin</em></li>
|
|
<li><em>https://www.googleapis.com/auth/cloud-bigtable.admin.cluster</em></li>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigtable.admin</em>.
|
|
You can set the scope for this method like this: <code>bigtableadmin2 --scope <scope> projects instances-set-iam-policy ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><resource></strong> <em>(string)</em><ul>
|
|
<li>REQUIRED: The resource for which the policy is being specified. See <a href="https://cloud.google.com/apis/design/resource_names">Resource names</a> for the appropriate value for this field.</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>SetIamPolicyRequest:
|
|
policy:
|
|
etag: string
|
|
version: integer
|
|
update-mask: 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 .policy etag=no</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>
|
|
</li>
|
|
<li>
|
|
<p><code>version=94</code></p>
|
|
<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>
|
|
<li>
|
|
<p><code>.. update-mask=at</code></p>
|
|
<ul>
|
|
<li>OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: <code>paths: &#34;bindings, etag&#34;</code></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-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_instances-partial-update-instance/" class="btn btn-neutral float-left" title="Instances Partial Update Instance"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_instances-tables-check-consistency/" class="btn btn-neutral float-right" title="Instances Tables Check Consistency">Next <span class="icon icon-circle-arrow-right"></span></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/bigtableadmin2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_instances-partial-update-instance/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_instances-tables-check-consistency/" style="color: #fcfcfc">Next »</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>
|