OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-27 12:20:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_accesscontextmanager1_cli/access-policies_create/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

447 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Create - Access Context Manager v3.0.0+20220301</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Access Context Manager v3.0.0+20220301</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Access Policies</span>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-create">Access Levels Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-delete">Access Levels Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-get">Access Levels Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-list">Access Levels List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-patch">Access Levels Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-replace-all">Access Levels Replace All</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_access-levels-test-iam-permissions">Access Levels Test Iam Permissions</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Create</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-commit">Service Perimeters Commit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-create">Service Perimeters Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-delete">Service Perimeters Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-get">Service Perimeters Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-list">Service Perimeters List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-patch">Service Perimeters Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-replace-all">Service Perimeters Replace All</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_service-perimeters-test-iam-permissions">Service Perimeters Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../access-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_list">List</a>
</li>
<span>Organizations</span>
<li class="toctree-l1 ">
<a class="" href="../organizations_gcp-user-access-bindings-create">Gcp User Access Bindings Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_gcp-user-access-bindings-delete">Gcp User Access Bindings Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_gcp-user-access-bindings-get">Gcp User Access Bindings Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_gcp-user-access-bindings-list">Gcp User Access Bindings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_gcp-user-access-bindings-patch">Gcp User Access Bindings Patch</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/accesscontextmanager1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in <code>metadata</code> as a BadRequest proto.</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>accesscontextmanager1 --scope &lt;scope&gt; access-policies create ...</code></p>
<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>AccessPolicy:
etag: string
name: string
parent: string
scopes: [string]
title: 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 . etag=ea</code><ul>
<li>Output only. An opaque identifier for the current version of the <code>AccessPolicy</code>. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.</li>
</ul>
</li>
<li><code>name=ipsum</code><ul>
<li>Output only. Resource name of the <code>AccessPolicy</code>. Format: <code>accessPolicies/{access_policy}</code></li>
</ul>
</li>
<li><code>parent=invidunt</code><ul>
<li>Required. The parent of this <code>AccessPolicy</code> in the Cloud Resource Hierarchy. Currently immutable once created. Format: <code>organizations/{organization_id}</code></li>
</ul>
</li>
<li><code>scopes=amet</code><ul>
<li>The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[&#34;folders/123&#34;] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes &#34;folders/123&#34; will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of <code>folders/{folder_number}</code> or <code>projects/{project_number}</code></li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>title=duo</code><ul>
<li>Required. Human readable title. Does not affect behavior.</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. &#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>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../access-policies_delete" class="btn btn-neutral float-right" title="Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../access-policies_access-levels-test-iam-permissions" class="btn btn-neutral" title="Access Levels Test Iam Permissions"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../access-policies_access-levels-test-iam-permissions" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../access-policies_delete" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink