Files
google-apis-rs/google_sasportal1_alpha1_cli/nodes_deployments-patch/index.html
2024-03-05 21:06:01 +01:00

453 lines
23 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-sasportal1_alpha1-cli/nodes_deployments-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Deployments Patch - sasportal 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 = "Deployments Patch";
var mkdocs_page_input_path = "nodes_deployments-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-sasportal1_alpha1-cli/nodes_deployments-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"> sasportal 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">Customers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-create/">Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-delete/">Deployments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-create/">Deployments Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-create-signed/">Deployments Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-list/">Deployments Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-get/">Deployments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-list/">Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-move/">Deployments Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-patch/">Deployments Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-create/">Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-create-signed/">Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-list/">Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-patch/">Devices Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list-gcp-project-deployments/">List Gcp Project Deployments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list-legacy-organizations/">List Legacy Organizations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_migrate-organization/">Migrate Organization</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-create/">Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-delete/">Nodes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-deployments-create/">Nodes Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-deployments-list/">Nodes Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-create/">Nodes Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-create-signed/">Nodes Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-list/">Nodes Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-get/">Nodes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-list/">Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-move/">Nodes Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-nodes-create/">Nodes Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-nodes-list/">Nodes Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-patch/">Nodes Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_provision-deployment/">Provision Deployment</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_setup-sas-analytics/">Setup Sas Analytics</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Deployments</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-patch/">Devices Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Installer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installer_generate-secret/">Generate Secret</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installer_validate/">Validate</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Nodes</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-delete/">Deployments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-create/">Deployments Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-create-signed/">Deployments Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-list/">Deployments Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-get/">Deployments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-list/">Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-move/">Deployments Move</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Deployments Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-create/">Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-create-signed/">Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-list/">Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-patch/">Devices Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-create/">Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-delete/">Nodes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-deployments-create/">Nodes Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-deployments-list/">Nodes Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-create/">Nodes Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-create-signed/">Nodes Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-list/">Nodes Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-get/">Nodes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-list/">Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-move/">Nodes Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-nodes-create/">Nodes Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-nodes-list/">Nodes Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-patch/">Nodes Patch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Policies</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../policies_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../policies_set/">Set</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../policies_test/">Test</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="..">sasportal 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> &raquo;</li>
<li>Nodes &raquo;</li>
<li>Deployments Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/sasportal1_alpha1-cli/edit/master/docs/nodes_deployments-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 an existing deployment.</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/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/sasportal</em></li>
</ul>
<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>sasportal1-alpha1 --scope &lt;scope&gt; nodes deployments-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Output only. Resource name.</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>SasPortalDeployment:
display-name: string
frns: [string]
name: string
sas-user-ids: [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 . display-name=sanctus</code><ul>
<li>The deployment&#39;s display name.</li>
</ul>
</li>
<li><code>frns=dolores</code><ul>
<li>Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>name=elitr</code><ul>
<li>Output only. Resource name.</li>
</ul>
</li>
<li><code>sas-user-ids=diam</code><ul>
<li>User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.</li>
<li>Each invocation of this argument appends the given value to the array.</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>Fields to be updated.</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="../nodes_deployments-move/" class="btn btn-neutral float-left" title="Deployments Move"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../nodes_devices-create/" class="btn btn-neutral float-right" title="Devices Create">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/sasportal1_alpha1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../nodes_deployments-move/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../nodes_devices-create/" style="color: #fcfcfc">Next &raquo;</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>