mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
325 lines
15 KiB
HTML
325 lines
15 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-cloudbilling1-cli/billing-accounts_patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Patch - Cloudbilling v5.0.4+20240214</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 = "Patch";
|
|
var mkdocs_page_input_path = "billing-accounts_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudbilling1-cli/billing-accounts_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"> Cloudbilling v5.0.4+20240214
|
|
</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">Billing Accounts</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_get-iam-policy/">Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_move/">Move</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_projects-list/">Projects List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_set-iam-policy/">Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_sub-accounts-create/">Sub Accounts Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_sub-accounts-list/">Sub Accounts List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-accounts_test-iam-permissions/">Test Iam Permissions</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Organizations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_billing-accounts-create/">Billing Accounts Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_billing-accounts-list/">Billing Accounts List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../organizations_billing-accounts-move/">Billing Accounts Move</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_get-billing-info/">Get Billing Info</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_update-billing-info/">Update Billing Info</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Services</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../services_skus-list/">Skus 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="..">Cloudbilling v5.0.4+20240214</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>Billing Accounts »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbilling1-cli/edit/master/docs/billing-accounts_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 a billing account's fields. Currently the only field that can be edited is <code>display_name</code>. The current authenticated user must have the <code>billing.accounts.update</code> IAM permission, which is typically given to the <a href="https://cloud.google.com/billing/docs/how-to/billing-access">administrator</a> of the billing account.</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-billing</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/cloud-billing</em>.
|
|
You can set the scope for this method like this: <code>cloudbilling1 --scope <scope> billing-accounts patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. The name of the billing account resource to be updated.</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>BillingAccount:
|
|
display-name: string
|
|
master-billing-account: string
|
|
name: string
|
|
open: boolean
|
|
parent: 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 display name given to the billing account, such as <code>My Billing Account</code>. This name is displayed in the Google Cloud Console.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>master-billing-account=sed</code><ul>
|
|
<li>If this account is a <a href="https://cloud.google.com/billing/docs/concepts">subaccount</a>, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=amet.</code><ul>
|
|
<li>Output only. The resource name of the billing account. The resource name has the form <code>billingAccounts/{billing_account_id}</code>. For example, <code>billingAccounts/012345-567890-ABCDEF</code> would be the resource name for billing account <code>012345-567890-ABCDEF</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>open=true</code><ul>
|
|
<li>Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>parent=amet.</code><ul>
|
|
<li>Output only. The billing account's parent resource identifier. Use the <code>MoveBillingAccount</code> method to update the account's parent resource if it is a organization. Format: - <code>organizations/{organization_id}</code>, for example, <code>organizations/12345678</code> - <code>billingAccounts/{billing_account_id}</code>, for example, <code>billingAccounts/012345-567890-ABCDEF</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-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>The update mask applied to the resource. Only "display_name" is currently supported.</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="../billing-accounts_move/" class="btn btn-neutral float-left" title="Move"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../billing-accounts_projects-list/" class="btn btn-neutral float-right" title="Projects List">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/cloudbilling1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../billing-accounts_move/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../billing-accounts_projects-list/" 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>
|