mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-31 06:12:47 +01:00
328 lines
22 KiB
HTML
328 lines
22 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-cloudasset1-cli/methods_search-all-resources/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Search All Resources - Cloud Asset v5.0.4+20240302</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 = "Search All Resources";
|
|
var mkdocs_page_input_path = "methods_search-all-resources.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudasset1-cli/methods_search-all-resources/";
|
|
</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 Asset v5.0.4+20240302
|
|
</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">Assets</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../assets_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Effective Iam Policies</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../effective-iam-policies_batch-get/">Batch Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Feeds</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_patch/">Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Methods</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-iam-policy/">Analyze Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-iam-policy-longrunning/">Analyze Iam Policy Longrunning</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-move/">Analyze Move</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policies/">Analyze Org Policies</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policy-governed-assets/">Analyze Org Policy Governed Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policy-governed-containers/">Analyze Org Policy Governed Containers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_batch-get-assets-history/">Batch Get Assets History</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_export-assets/">Export Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_query-assets/">Query Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_search-all-iam-policies/">Search All Iam Policies</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Search All Resources</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Saved Queries</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_patch/">Patch</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 Asset v5.0.4+20240302</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>Methods »</li>
|
|
<li>Search All Resources</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudasset1-cli/edit/master/docs/methods_search-all-resources.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>Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the <code>cloudasset.assets.searchAllResources</code> permission on the desired scope, otherwise the request will be rejected.</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>cloudasset1 --scope <scope> methods search-all-resources ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><scope></strong> <em>(string)</em><ul>
|
|
<li>Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the <code>scope</code>. The caller must be granted the <a href="https://cloud.google.com/asset-inventory/docs/access-control#required_permissions"><code>cloudasset.assets.searchAllResources</code></a> permission on the desired scope. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")</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>
|
|
<p><strong>-p asset-types=string</strong></p>
|
|
<ul>
|
|
<li>Optional. A list of asset types that this request searches for. If empty, it will search all the asset types <a href="https://cloud.google.com/asset-inventory/docs/supported-asset-types">supported by search APIs</a>. Regular expressions are also supported. For example: * "compute.googleapis.com.<em>" snapshots resources whose asset type starts with "compute.googleapis.com". * ".</em>Instance" snapshots resources whose asset type ends with "Instance". * ".<em>Instance.</em>" snapshots resources whose asset type contains "Instance". See <a href="https://github.com/google/re2/wiki/Syntax">RE2</a> for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p order-by=string</strong></p>
|
|
<ul>
|
|
<li>Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only the following fields in the response are sortable: * name * assetType * project * displayName * description * location * createTime * updateTime * state * parentFullResourceName * parentAssetType</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-size=integer</strong></p>
|
|
<ul>
|
|
<li>Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero or a negative value, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as <code>next_page_token</code> is returned.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-token=string</strong></p>
|
|
<ul>
|
|
<li>Optional. If present, then retrieve the next batch of results from the preceding call to this method. <code>page_token</code> must be the value of <code>next_page_token</code> from the previous response. The values of all other method parameters, must be identical to those in the previous call.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p query=string</strong></p>
|
|
<ul>
|
|
<li>Optional. The query statement. See <a href="https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query">how to construct a query</a> for more information. If not specified or empty, it will search all the resources within the specified <code>scope</code>. Examples: * <code>name:Important</code> to find Google Cloud resources whose name contains <code>Important</code> as a word. * <code>name=Important</code> to find the Google Cloud resource whose name is exactly <code>Important</code>. * <code>displayName:Impor*</code> to find Google Cloud resources whose display name contains <code>Impor</code> as a prefix of any word in the field. * <code>location:us-west*</code> to find Google Cloud resources whose location contains both <code>us</code> and <code>west</code> as prefixes. * <code>labels:prod</code> to find Google Cloud resources whose labels contain <code>prod</code> as a key or value. * <code>labels.env:prod</code> to find Google Cloud resources that have a label <code>env</code> and its value is <code>prod</code>. * <code>labels.env:*</code> to find Google Cloud resources that have a label <code>env</code>. * <code>tagKeys:env</code> to find Google Cloud resources that have directly attached tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey"><code>TagKey.namespacedName</code></a> contains <code>env</code>. * <code>tagValues:prod*</code> to find Google Cloud resources that have directly attached tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue"><code>TagValue.namespacedName</code></a> contains a word prefixed by <code>prod</code>. * <code>tagValueIds=tagValues/123</code> to find Google Cloud resources that have directly attached tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue"><code>TagValue.name</code></a> is exactly <code>tagValues/123</code>. * <code>effectiveTagKeys:env</code> to find Google Cloud resources that have directly attached or inherited tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey"><code>TagKey.namespacedName</code></a> contains <code>env</code>. * <code>effectiveTagValues:prod*</code> to find Google Cloud resources that have directly attached or inherited tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue"><code>TagValue.namespacedName</code></a> contains a word prefixed by <code>prod</code>. * <code>effectiveTagValueIds=tagValues/123</code> to find Google Cloud resources that have directly attached or inherited tags where the <a href="https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue"><code>TagValue.name</code></a> is exactly <code>tagValues/123</code>. * <code>kmsKey:key</code> to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains <code>key</code> as a word. This field is deprecated. Use the <code>kmsKeys</code> field to retrieve Cloud KMS key information. * <code>kmsKeys:key</code> to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word <code>key</code>. * <code>relationships:instance-group-1</code> to find Google Cloud resources that have relationships with <code>instance-group-1</code> in the related resource name. * <code>relationships:INSTANCE_TO_INSTANCEGROUP</code> to find Compute Engine instances that have relationships of type <code>INSTANCE_TO_INSTANCEGROUP</code>. * <code>relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1</code> to find Compute Engine instances that have relationships with <code>instance-group-1</code> in the Compute Engine instance group resource name, for relationship type <code>INSTANCE_TO_INSTANCEGROUP</code>. * <code>sccSecurityMarks.key=value</code> to find Cloud resources that are attached with security marks whose key is <code>key</code> and value is <code>value</code>. * <code>sccSecurityMarks.key:*</code> to find Cloud resources that are attached with security marks whose key is <code>key</code>. * <code>state:ACTIVE</code> to find Google Cloud resources whose state contains <code>ACTIVE</code> as a word. * <code>NOT state:ACTIVE</code> to find Google Cloud resources whose state doesn't contain <code>ACTIVE</code> as a word. * <code>createTime&lt;1609459200</code> to find Google Cloud resources that were created before <code>2021-01-01 00:00:00 UTC</code>. <code>1609459200</code> is the epoch timestamp of <code>2021-01-01 00:00:00 UTC</code> in seconds. * <code>updateTime&gt;1609459200</code> to find Google Cloud resources that were updated after <code>2021-01-01 00:00:00 UTC</code>. <code>1609459200</code> is the epoch timestamp of <code>2021-01-01 00:00:00 UTC</code> in seconds. * <code>Important</code> to find Google Cloud resources that contain <code>Important</code> as a word in any of the searchable fields. * <code>Impor*</code> to find Google Cloud resources that contain <code>Impor</code> as a prefix of any word in any of the searchable fields. * <code>Important location:(us-west1 OR global)</code> to find Google Cloud resources that contain <code>Important</code> as a word in any of the searchable fields and are also located in the <code>us-west1</code> region or the <code>global</code> location.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p read-mask=string</strong></p>
|
|
<ul>
|
|
<li>Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * <code>name</code> * <code>assetType</code> * <code>project</code> * <code>folders</code> * <code>organization</code> * <code>displayName</code> * <code>description</code> * <code>location</code> * <code>labels</code> * <code>tags</code> * <code>effectiveTags</code> * <code>networkTags</code> * <code>kmsKeys</code> * <code>createTime</code> * <code>updateTime</code> * <code>state</code> * <code>additionalAttributes</code> * <code>parentFullResourceName</code> * <code>parentAssetType</code> Some fields of large size, such as <code>versionedResources</code>, <code>attachedResources</code>, <code>effectiveTags</code> etc., are not returned by default, but you can specify them in the <code>read_mask</code> parameter if you want to include them. If <code>&#34;*&#34;</code> is specified, all <a href="https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult">available fields</a> are returned. Examples: <code>&#34;name,location&#34;</code>, <code>&#34;name,versionedResources&#34;</code>, <code>&#34;*&#34;</code>. Any invalid field path will trigger INVALID_ARGUMENT error.</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="../methods_search-all-iam-policies/" class="btn btn-neutral float-left" title="Search All Iam Policies"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../operations_get/" class="btn btn-neutral float-right" title="Get">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/cloudasset1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../methods_search-all-iam-policies/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../operations_get/" 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>
|