gcloud asset export Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud asset export - export the cloud assets to Google Cloud Storage/BigQuery
- SYNOPSIS
gcloud asset export(--folder=FOLDER_ID|--organization=ORGANIZATION_ID|--project=PROJECT_ID)(--output-path=OUTPUT_PATH|--output-path-prefix=OUTPUT_PATH_PREFIX| [(--bigquery-table=BIGQUERY_TABLE:--bigquery-dataset=BIGQUERY_DATASET) :--output-bigquery-force--partition-key=PARTITION_KEY--per-asset-type])[--asset-types=[ASSET_TYPES,…]][--content-type=CONTENT_TYPE][--relationship-types=[RELATIONSHIP_TYPES,…]][--snapshot-time=SNAPSHOT_TIME][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Export the cloud assets to Google Cloud Storage or BigQuery. Use gcloud assetoperations describe to get the latest status of the operation. Note that toexport a project different from the project you want to bill, you can use--billing-project or authenticate with a service account. Seehttps://cloud.google.com/resource-manager/docs/cloud-asset-inventory/gcloud-assetfor examples of using a service account.
- EXAMPLES
- To export a snapshot of assets of type 'compute.googleapis.com/Disk' in project'test-project' at '2019-03-05T00:00:00Z' to 'gs://bucket-name/object-name' andonly export the asset metadata, run:
gcloudassetexport--project='test-project'--asset-types='compute.googleapis.com/Disk'--snapshot-time='2019-03-05T00:00:00Z'--output-path='gs://bucket-name/object-name'--content-type='resource'To export a snapshot of assets of type 'compute.googleapis.com/Disk' in project'test-project' at '2019-03-05T00:00:00Z' to'projects/projectId/datasets/datasetId/tables/table_name', overwrite the tableif existed, run:
gcloudassetexport--project='test-project'--asset-types='compute.googleapis.com/Disk'--snapshot-time='2019-03-05T00:00:00Z'--bigquery-table='projects/projectId/datasets/datasetId/tables/table_name'--output-bigquery-force--content-type='resource' - REQUIRED FLAGS
- Exactly one of these must be specified:
--folder=FOLDER_ID- The ID of the folder which is the root asset.
--organization=ORGANIZATION_ID- The ID of the organization which is the root asset.
--project=PROJECT_ID- The project which is the root asset.
The Google Cloud project ID to use for this invocation. If omitted, then thecurrent project is assumed; the current project can be listed using
gcloudconfig list --format='text(core.project)'and can be set usinggcloud config set project PROJECTID.--projectand its fallbackcore/projectproperty playtwo roles in the invocation. It specifies the project of the resource to operateon. It also specifies the project for API enablement check, quota, and billing.To specify a different project for quota and billing, use--billing-projectorbilling/quota_projectproperty.
- The destination path for exporting assets.
Exactly one of these must be specified:
--output-path=OUTPUT_PATH- Google Cloud Storage URI where the results will go. URI must start with "gs://".For example, "gs://bucket_name/object_name"
--output-path-prefix=OUTPUT_PATH_PREFIX- Google Cloud Storage URI where the results will go. URI must start with "gs://".For example, "gs://bucket_name/object_name_prefix", in which case each exportedobject uri is in format: "gs://bucket_name/object_name_prefix/<assettype>/<shard number>" and it only contains assets for that type.
- The BigQuery destination for exporting assets.
--output-bigquery-force- If the destination table already exists and this flag is specified, the tablewill be overwritten by the contents of assets snapshot. If the flag is notspecified and the destination table already exists, the export call returns anerror.
--partition-key=PARTITION_KEY- If specified. the snapshot results will be written to partitioned table(s) withtwo additional timestamp columns, readTime and requestTime, one of which will bethe partition key.
PARTITION_KEYmust be one of:read-time,request-time. --per-asset-type- If the flag is specified, the snapshot results will be written to one or moretables, each of which contains results of one asset type.
- Table resource - The bigquery-table export to. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
--bigquery-tableon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
--bigquery-table=BIGQUERY_TABLE- ID of the table or fully qualified identifier for the table.
To set the
tableattribute:- provide the argument
--bigquery-tableon the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--bigquery-dataset=BIGQUERY_DATASET- The id of the BigQuery dataset.
To set the
bigquery-datasetattribute:- provide the argument
--bigquery-tableon the command line with afully specified name; - provide the argument
--bigquery-dataseton the command line.
- provide the argument
- provide the argument
- Exactly one of these must be specified:
- OPTIONAL FLAGS
--asset-types=[ASSET_TYPES,…]- A list of asset types (i.e., "compute.googleapis.com/Disk") to take a snapshot.If specified and non-empty, only assets matching the specified types will bereturned. Seehttp://cloud.google.com/asset-inventory/docs/supported-asset-typesfor supported asset types.
--content-type=CONTENT_TYPE- Asset content type. If specified, only content matching the specified type willbe returned. Otherwise, no content but the asset name will be returned.Specifying
resourcewill export resource metadata, specifyingiam-policywill export the IAM policy for each child asset,specifyingorg-policywill export the Org Policy set on childassets, specifyingaccess-policywill export the Access Policy seton child assets, specifyingos-inventorywill export the OSinventory of VM instances, and specifyingrelationshipwill exportrelationships of the assets.CONTENT_TYPEmust be oneof:resource,iam-policy,org-policy,access-policy,os-inventory,relationship. --relationship-types=[RELATIONSHIP_TYPES,…]- A list of relationship types (i.e., "INSTANCE_TO_INSTANCEGROUP") to take asnapshot. This argument will only be honoured if content_type=RELATIONSHIP. Ifspecified and non-empty, only relationships matching the specified types will bereturned. Seehttp://cloud.google.com/asset-inventory/docs/supported-asset-typesfor supported relationship types.
--snapshot-time=SNAPSHOT_TIME- Timestamp to take a snapshot on assets. This can only be a current or past time.If not specified, the current time will be used. Due to delays in resource datacollection and indexing, there is a volatile window during which running thesame query at different times may return different results. See $gcloud topic datetimes forinformation on time formats.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- These variants are also available:
gcloudalphaassetexportgcloudbetaassetexport
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.