mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-01 14:54:02 +01:00
378 lines
17 KiB
HTML
378 lines
17 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-cloudkms1_beta1-cli/projects_locations-key-rings-crypto-keys-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Key Rings Crypto Keys Patch - Cloud KMS v5.0.4+20170515</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 = "Locations Key Rings Crypto Keys Patch";
|
|
var mkdocs_page_input_path = "projects_locations-key-rings-crypto-keys-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudkms1_beta1-cli/projects_locations-key-rings-crypto-keys-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"> Cloud KMS v5.0.4+20170515
|
|
</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">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-create/">Locations Key Rings Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-create/">Locations Key Rings Crypto Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-create/">Locations Key Rings Crypto Keys Crypto Key Versions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-destroy/">Locations Key Rings Crypto Keys Crypto Key Versions Destroy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-get/">Locations Key Rings Crypto Keys Crypto Key Versions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-list/">Locations Key Rings Crypto Keys Crypto Key Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-patch/">Locations Key Rings Crypto Keys Crypto Key Versions Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-crypto-key-versions-restore/">Locations Key Rings Crypto Keys Crypto Key Versions Restore</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-decrypt/">Locations Key Rings Crypto Keys Decrypt</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-encrypt/">Locations Key Rings Crypto Keys Encrypt</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-get/">Locations Key Rings Crypto Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-get-iam-policy/">Locations Key Rings Crypto Keys Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-list/">Locations Key Rings Crypto Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Key Rings Crypto Keys Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-set-iam-policy/">Locations Key Rings Crypto Keys Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-test-iam-permissions/">Locations Key Rings Crypto Keys Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-crypto-keys-update-primary-version/">Locations Key Rings Crypto Keys Update Primary Version</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-get/">Locations Key Rings Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-get-iam-policy/">Locations Key Rings Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-list/">Locations Key Rings List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-set-iam-policy/">Locations Key Rings Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-key-rings-test-iam-permissions/">Locations Key Rings Test Iam Permissions</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="..">Cloud KMS v5.0.4+20170515</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>Locations Key Rings Crypto Keys Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudkms1_beta1-cli/edit/master/docs/projects_locations-key-rings-crypto-keys-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>Update a CryptoKey.</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>cloudkms1-beta1 --scope <scope> projects locations-key-rings-crypto-keys-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Output only. The resource name for this CryptoKey in the format
|
|
<code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</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>CryptoKey:
|
|
create-time: string
|
|
name: string
|
|
next-rotation-time: string
|
|
primary:
|
|
create-time: string
|
|
destroy-event-time: string
|
|
destroy-time: string
|
|
name: string
|
|
state: string
|
|
purpose: string
|
|
rotation-period: 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 . create-time=gubergren</code><ul>
|
|
<li>Output only. The time at which this CryptoKey was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=rebum.</code><ul>
|
|
<li>Output only. The resource name for this CryptoKey in the format
|
|
<code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>next-rotation-time=est</code></p>
|
|
<ul>
|
|
<li>
|
|
<p>At next_rotation_time, the Key Management Service will automatically:</p>
|
|
<ol>
|
|
<li>Create a new version of this CryptoKey.</li>
|
|
<li>Mark the new version as primary.</li>
|
|
</ol>
|
|
<p>Key rotations performed manually via
|
|
CreateCryptoKeyVersion and
|
|
UpdateCryptoKeyPrimaryVersion
|
|
do not affect next_rotation_time.
|
|
* <code>primary create-time=ipsum</code>
|
|
- Output only. The time at which this CryptoKeyVersion was created.
|
|
* <code>destroy-event-time=ipsum</code>
|
|
- Output only. The time this CryptoKeyVersion's key material was
|
|
destroyed. Only present if state is
|
|
DESTROYED.
|
|
* <code>destroy-time=est</code>
|
|
- Output only. The time this CryptoKeyVersion's key material is scheduled
|
|
for destruction. Only present if state is
|
|
DESTROY_SCHEDULED.
|
|
* <code>name=gubergren</code>
|
|
- Output only. The resource name for this CryptoKeyVersion in the format
|
|
<code>projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*</code>.
|
|
* <code>state=ea</code>
|
|
- The current state of the CryptoKeyVersion.</p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. purpose=dolor</code></p>
|
|
<ul>
|
|
<li>The immutable purpose of this CryptoKey. Currently, the only acceptable
|
|
purpose is ENCRYPT_DECRYPT.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>rotation-period=lorem</code><ul>
|
|
<li>
|
|
<p>next_rotation_time will be advanced by this period when the service
|
|
automatically rotates a key. Must be at least one day.</p>
|
|
<p>If rotation_period is set, next_rotation_time must also be set.</p>
|
|
</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>Required list of fields to be updated in this 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 bearer-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth bearer token.</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 pp=boolean</strong></p>
|
|
<ul>
|
|
<li>Pretty-print response.</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_locations-key-rings-crypto-keys-list/" class="btn btn-neutral float-left" title="Locations Key Rings Crypto Keys List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-key-rings-crypto-keys-set-iam-policy/" class="btn btn-neutral float-right" title="Locations Key Rings Crypto Keys Set Iam Policy">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/cloudkms1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-key-rings-crypto-keys-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-key-rings-crypto-keys-set-iam-policy/" 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>
|