Files
google-apis-rs/google_container1_cli/projects_zones-clusters-delete/index.html
2024-03-05 21:06:01 +01:00

371 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-container1-cli/projects_zones-clusters-delete/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Zones Clusters Delete - Container 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 = "Zones Clusters Delete";
var mkdocs_page_input_path = "projects_zones-clusters-delete.md";
var mkdocs_page_url = "/google-apis-rs/google-container1-cli/projects_zones-clusters-delete/";
</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"> Container 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">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_aggregated-usable-subnetworks-list/">Aggregated Usable Subnetworks List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-check-autopilot-compatibility/">Locations Clusters Check Autopilot Compatibility</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-complete-ip-rotation/">Locations Clusters Complete Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-create/">Locations Clusters Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-delete/">Locations Clusters Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-get/">Locations Clusters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-get-jwks/">Locations Clusters Get Jwks</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-list/">Locations Clusters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-complete-upgrade/">Locations Clusters Node Pools Complete Upgrade</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-create/">Locations Clusters Node Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-delete/">Locations Clusters Node Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-get/">Locations Clusters Node Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-list/">Locations Clusters Node Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-rollback/">Locations Clusters Node Pools Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-autoscaling/">Locations Clusters Node Pools Set Autoscaling</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-management/">Locations Clusters Node Pools Set Management</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-set-size/">Locations Clusters Node Pools Set Size</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-node-pools-update/">Locations Clusters Node Pools Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-addons/">Locations Clusters Set Addons</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-legacy-abac/">Locations Clusters Set Legacy Abac</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-locations/">Locations Clusters Set Locations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-logging/">Locations Clusters Set Logging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-maintenance-policy/">Locations Clusters Set Maintenance Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-master-auth/">Locations Clusters Set Master Auth</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-monitoring/">Locations Clusters Set Monitoring</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-network-policy/">Locations Clusters Set Network Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-set-resource-labels/">Locations Clusters Set Resource Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-start-ip-rotation/">Locations Clusters Start Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-update/">Locations Clusters Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-update-master/">Locations Clusters Update Master</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-clusters-well-known-get-openid-configuration/">Locations Clusters Well Known Get Openid Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-server-config/">Locations Get Server Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-addons/">Zones Clusters Addons</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-complete-ip-rotation/">Zones Clusters Complete Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-create/">Zones Clusters Create</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Zones Clusters Delete</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-get/">Zones Clusters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-legacy-abac/">Zones Clusters Legacy Abac</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-list/">Zones Clusters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-locations/">Zones Clusters Locations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-logging/">Zones Clusters Logging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-master/">Zones Clusters Master</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-monitoring/">Zones Clusters Monitoring</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-autoscaling/">Zones Clusters Node Pools Autoscaling</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-create/">Zones Clusters Node Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-delete/">Zones Clusters Node Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-get/">Zones Clusters Node Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-list/">Zones Clusters Node Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-rollback/">Zones Clusters Node Pools Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-set-management/">Zones Clusters Node Pools Set Management</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-set-size/">Zones Clusters Node Pools Set Size</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-node-pools-update/">Zones Clusters Node Pools Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-resource-labels/">Zones Clusters Resource Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-set-maintenance-policy/">Zones Clusters Set Maintenance Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-set-master-auth/">Zones Clusters Set Master Auth</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-set-network-policy/">Zones Clusters Set Network Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-start-ip-rotation/">Zones Clusters Start Ip Rotation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-clusters-update/">Zones Clusters Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-get-serverconfig/">Zones Get Serverconfig</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-cancel/">Zones Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-get/">Zones Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_zones-operations-list/">Zones Operations 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="..">Container 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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Zones Clusters Delete</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/container1-cli/edit/master/docs/projects_zones-clusters-delete.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>Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren&#39;t present when the cluster was initially created.</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>container1 --scope &lt;scope&gt; projects zones-clusters-delete ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The Google Developers Console <a href="https://cloud.google.com/resource-manager/docs/creating-managing-projects">project ID or project number</a>. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><strong>&lt;zone&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The name of the Google Compute Engine <a href="https://cloud.google.com/compute/docs/zones#available">zone</a> in which the cluster resides. This field has been deprecated and replaced by the name field.</li>
</ul>
</li>
<li><strong>&lt;cluster-id&gt;</strong> <em>(string)</em><ul>
<li>Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.</li>
</ul>
</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 name=string</strong><ul>
<li>The name (project, location, cluster) of the cluster to delete. Specified in the format <code>projects/*/locations/*/clusters/*</code>.</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="../projects_zones-clusters-create/" class="btn btn-neutral float-left" title="Zones Clusters Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_zones-clusters-get/" class="btn btn-neutral float-right" title="Zones Clusters Get">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/container1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_zones-clusters-create/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_zones-clusters-get/" 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>