Este documento mostra como exportar os metadados dos recursos do seu projeto para um contentor do Cloud Storage.
Antes de começar
Ative a API Cloud Asset Inventory no projeto a partir do qual está a executar comandos do Cloud Asset Inventory.
Certifique-se de que a sua conta tem a função correta para chamar a API Cloud Asset Inventory. Para ver as autorizações individuais de cada tipo de chamada, consulte a secção Autorizações.
Crie um contentor do Cloud Storage para exportar, se ainda não tiver um.
Limitações
Os contentores do Cloud Storage encriptados com chaves personalizadas do Cloud Key Management Service (Cloud KMS) não são suportados.
O contentor do Cloud Storage não pode ter uma política de retenção definida.
Durante a exportação, a operação pode criar ficheiros temporários na pasta de saída. Não remova estes ficheiros temporários enquanto a operação estiver em curso. Após a conclusão da operação, os ficheiros temporários são removidos automaticamente.
O tipo de conteúdo
ACCESS_POLICY
só pode ser exportado ao nível da organização.Se o ficheiro para o qual está a exportar já existir e estiver em processo de exportação, é devolvido um erro
400
.Para testar as autorizações, o Cloud Asset Inventory cria um ficheiro vazio antes de exportar os dados, o que envia um evento de acionador do Cloud Storage adicional de
google.cloud.storage.object.v1.finalized
.
Exporte um resumo de recursos para o Cloud Storage
gcloud
gcloud asset export \ --SCOPE \ --billing-project=BILLING_PROJECT_ID \ --asset-types=ASSET_TYPE_1,ASSET_TYPE_2,... \ --content-type=CONTENT_TYPE \ --relationship-types=RELATIONSHIP_TYPE_1,RELATIONSHIP_TYPE_2,... \ --snapshot-time="SNAPSHOT_TIME" \ --OUTPUT_TYPE
Indique os seguintes valores:
-
SCOPE
: use um dos seguintes valores:-
project=PROJECT_ID
, ondePROJECT_ID
é o ID do projeto que tem os metadados dos recursos que quer exportar. -
folder=FOLDER_ID
, ondeFOLDER_ID
é o ID da pasta que tem os metadados dos recursos que quer exportar.Como encontrar o ID de uma Google Cloud pasta
Google Cloud consola
Para encontrar o ID de uma Google Cloud pasta, conclua os seguintes passos:
-
Aceda à Google Cloud consola.
- Clique na caixa de lista do comutador na barra de menu.
- Selecione a sua organização na caixa de lista.
- Pesquise o nome da pasta. O ID da pasta é apresentado junto ao nome da pasta.
CLI gcloud
Pode obter o ID de uma Google Cloud pasta localizada ao nível da organização com o seguinte comando:
gcloud resource-manager folders list \ --organization=$(gcloud organizations describe ORGANIZATION_NAME \ --format="value(name.segment(1))") \ --filter='"DISPLAY_NAME":"TOP_LEVEL_FOLDER_NAME"' \ --format="value(ID)"
Onde TOP_LEVEL_FOLDER_NAME é uma correspondência de string parcial ou completa para o nome da pasta. Remova a flag
--format
para ver mais informações sobre as pastas encontradas.O comando anterior não devolve os IDs das subpastas dentro das pastas. Para tal, execute o seguinte comando com o ID de uma pasta de nível superior:
gcloud resource-manager folders list --folder=FOLDER_ID
-
-
organization=ORGANIZATION_ID
, ondeORGANIZATION_ID
é o ID da organização que tem os metadados dos recursos que quer exportar.Como encontrar o ID de uma Google Cloud organização
Google Cloud consola
Para encontrar o ID de uma Google Cloud organização, conclua os seguintes passos:
-
Aceda à Google Cloud consola.
- Clique na caixa de lista do comutador na barra de menu.
- Selecione a sua organização na caixa de lista.
- Clique no separador Tudo. O ID da organização é apresentado junto ao nome da organização.
CLI gcloud
Pode obter o ID de uma Google Cloud organização com o seguinte comando:
gcloud organizations describe ORGANIZATION_NAME --format="value(name.segment(1))"
-
-
-
BILLING_PROJECT_ID
: opcional. O ID do projeto no qual o agente de serviço do Cloud Asset Inventory predefinido tem autorizações para gerir os seus conjuntos de dados e tabelas do BigQuery. Leia mais sobre como definir o projeto de faturação. ASSET_TYPE_#
: opcional. Uma lista separada por vírgulas de tipos de recursos pesquisáveis. As expressões regulares compatíveis com RE2 são suportadas. Se a expressão regular não corresponder a nenhum tipo de recurso suportado, é devolvido um erroINVALID_ARGUMENT
. Quando--asset-types
não é especificado, são devolvidos todos os tipos de recursos.CONTENT_TYPE
: opcional. O tipo de conteúdo dos metadados que quer obter. Quando--content-type
não é especificado, apenas são devolvidas informações básicas, como os nomes dos recursos, a última vez que os recursos foram atualizados e a que projetos, pastas e organizações pertencem.-
RELATIONSHIP_TYPE_#
: opcional. Requer acesso ao nível Premium ou Enterprise do Security Command Center, ou ao Gemini Cloud Assist. Uma lista separada por vírgulas dos tipos de relações de recursos que quer obter. Tem de definirCONTENT_TYPE
comoRELATIONSHIP
para que isto funcione. -
SNAPSHOT_TIME
: opcional. A hora em que quer tirar uma captura instantânea dos seus recursos, no formato de data/hora do tópico gcloud. O valor não pode ser superior a 35 dias no passado. Quando--snapshot-time
não é especificado, é tirado um instantâneo na hora atual. -
OUTPUT_TYPE
: use um dos seguintes valores:--output-path="gs://BUCKET_NAME/FILE_NAME"
para escrever a saída num ficheiro, onde:-
BUCKET_NAME
é o nome do contentor do Cloud Storage para o qual escrever. -
FILE_NAME
é o ficheiro no qual escrever no seu contentor do Cloud Storage.
-
-
--output-path-prefix="gs://BUCKET_NAME/FOLDER_NAME"
para escrever a saída numa pasta, onde:-
BUCKET_NAME
é o nome do contentor do Cloud Storage para o qual escrever. -
FOLDER_NAME
é a pasta na qual escrever no seu contentor do Cloud Storage. A saída é dividida em subpastas com o nome dos tipos de recursos. As subpastas não podem já existir na pasta que especificar.
-
Consulte a referência da CLI gcloud para ver todas as opções.
Exemplo
Execute o seguinte comando para exportar os metadados do serviço resource
tal como estavam a 30 de janeiro de 2024 no projeto my-project
para o ficheiro my-file.txt
no contentor do Cloud Storage my-bucket
.
gcloud asset export \ --project=my-project \ --billing-project=my-project \ --content-type=resource \ --snapshot-time="2024-01-30" \ --output-path="gs://my-bucket/my-file.txt"
Exemplo de resposta
Export in progress for root asset [projects/my-project]. Use [gcloud asset operations describe projects/000000000000/operations/ExportAssets/RESOURCE/00000000000000000000000000000000] to check the status of the operation.
REST
Método HTTP e URL:
POST https://cloudasset.googleapis.com/v1/SCOPE_PATH:exportAssets
Cabeçalhos:
X-Goog-User-Project: BILLING_PROJECT_ID
Corpo JSON do pedido:
{ "assetTypes": [ "ASSET_TYPE_1", "ASSET_TYPE_2", "..." ], "contentType": "CONTENT_TYPE", "relationshipTypes": [ "RELATIONSHIP_TYPE_1", "RELATIONSHIP_TYPE_2", "..." ], "readTime": "SNAPSHOT_TIME", "outputConfig": { "gcsDestination": { OUTPUT_TYPE } } }
Indique os seguintes valores:
-
SCOPE_PATH
: use um dos seguintes valores:Os valores permitidos são:
-
projects/PROJECT_ID
, ondePROJECT_ID
é o ID do projeto que tem os metadados dos recursos que quer exportar. -
projects/PROJECT_NUMBER
, ondePROJECT_NUMBER
é o número do projeto que tem os metadados dos recursos que quer exportar.Como encontrar um Google Cloud número do projeto
Google Cloud consola
Para encontrar um Google Cloud número do projeto, conclua os seguintes passos:
-
Aceda à página Boas-vindas na Google Cloud consola.
- Clique na caixa de lista do comutador na barra de menu.
-
Selecione a sua organização na caixa de lista e, em seguida, pesquise o nome do projeto. O nome do projeto, o número do projeto e o ID do projeto são apresentados junto ao título Bem-vindo.
São apresentados até 4000 recursos. Se não vir o projeto que procura, aceda à página Gerir recursos e filtre a lista através do nome desse projeto.
CLI gcloud
Pode obter um Google Cloud número do projeto com o seguinte comando:
gcloud projects describe PROJECT_ID --format="value(projectNumber)"
-
-
folders/FOLDER_ID
, ondeFOLDER_ID
é o ID da pasta que tem os metadados dos recursos que quer exportar.Como encontrar o ID de uma Google Cloud pasta
Google Cloud consola
Para encontrar o ID de uma Google Cloud pasta, conclua os seguintes passos:
-
Aceda à Google Cloud consola.
- Clique na caixa de lista do comutador na barra de menu.
- Selecione a sua organização na caixa de lista.
- Pesquise o nome da pasta. O ID da pasta é apresentado junto ao nome da pasta.
CLI gcloud
Pode obter o ID de uma Google Cloud pasta localizada ao nível da organização com o seguinte comando:
gcloud resource-manager folders list \ --organization=$(gcloud organizations describe ORGANIZATION_NAME \ --format="value(name.segment(1))") \ --filter='"DISPLAY_NAME":"TOP_LEVEL_FOLDER_NAME"' \ --format="value(ID)"
Onde TOP_LEVEL_FOLDER_NAME é uma correspondência de string parcial ou completa para o nome da pasta. Remova a flag
--format
para ver mais informações sobre as pastas encontradas.O comando anterior não devolve os IDs das subpastas dentro das pastas. Para tal, execute o seguinte comando com o ID de uma pasta de nível superior:
gcloud resource-manager folders list --folder=FOLDER_ID
-
-
organizations/ORGANIZATION_ID
, ondeORGANIZATION_ID
é o ID da organização que tem os metadados dos recursos que quer exportar.Como encontrar o ID de uma Google Cloud organização
Google Cloud consola
Para encontrar o ID de uma Google Cloud organização, conclua os seguintes passos:
-
Aceda à Google Cloud consola.
- Clique na caixa de lista do comutador na barra de menu.
- Selecione a sua organização na caixa de lista.
- Clique no separador Tudo. O ID da organização é apresentado junto ao nome da organização.
CLI gcloud
Pode obter o ID de uma Google Cloud organização com o seguinte comando:
gcloud organizations describe ORGANIZATION_NAME --format="value(name.segment(1))"
-
-
-
BILLING_PROJECT_ID
: O ID do projeto em que o agente de serviço do Cloud Asset Inventory predefinido tem autorizações para gerir os seus conjuntos de dados e tabelas do BigQuery. Leia mais sobre como definir o projeto de faturação. ASSET_TYPE_#
: opcional. Uma matriz de tipos de recursos pesquisáveis. As expressões regulares compatíveis com RE2 são suportadas. Se a expressão regular não corresponder a nenhum tipo de recurso suportado, é devolvido um erroINVALID_ARGUMENT
. QuandoassetTypes
não é especificado, são devolvidos todos os tipos de recursos.CONTENT_TYPE
: opcional. O tipo de conteúdo dos metadados que quer obter. QuandocontentType
não é especificado, apenas são devolvidas informações básicas, como os nomes dos recursos, a última vez que os recursos foram atualizados e a que projetos, pastas e organizações pertencem.-
RELATIONSHIP_TYPE_#
: opcional. Requer acesso ao nível Premium ou Enterprise do Security Command Center, ou ao Gemini Cloud Assist. Uma lista separada por vírgulas dos tipos de relações de recursos que quer obter. Tem de definirCONTENT_TYPE
comoRELATIONSHIP
para que isto funcione. -
SNAPSHOT_TIME
: opcional. A hora em que quer tirar uma captura instantânea dos seus recursos, no formato RFC 3339. O valor não pode ser superior a 35 dias no passado. QuandoreadTime
não é especificado, é tirado um instantâneo na hora atual. -
OUTPUT_TYPE
: use um dos seguintes valores:"uri": "gs://BUCKET_NAME/FILE_NAME"
para escrever a saída num ficheiro, onde:-
BUCKET_NAME
é o nome do contentor do Cloud Storage para o qual escrever. -
FILE_NAME
é o ficheiro no qual escrever no seu contentor do Cloud Storage.
-
-
"uriPrefix": "gs://BUCKET_NAME/FOLDER_NAME"
para escrever a saída numa pasta, onde:-
BUCKET_NAME
é o nome do contentor do Cloud Storage para o qual escrever. -
FOLDER_NAME
é a pasta na qual escrever no seu contentor do Cloud Storage. A saída é dividida em subpastas com o nome dos tipos de recursos. As subpastas não podem já existir na pasta que especificar.
-
Consulte a referência REST para ver todas as opções.
Exemplos de comandos
Execute um dos seguintes comandos para exportar os seus metadados do resource
tal como estavam a 30 de janeiro de 2024 no projeto my-project
para o ficheiro my-file.txt
no contentor do Cloud Storage my-bucket
.
curl (Linux, macOS ou Cloud Shell)
curl -X POST \ -H "X-Goog-User-Project: BILLING_PROJECT_ID" \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "contentType": "RESOURCE", "readTime": "2024-01-30T00:00:00Z", "outputConfig": { "gcsDestination": { "uri": "gs://my-bucket/my-file" } } }' \ https://cloudasset.googleapis.com/v1/projects/my-project:exportAssets
PowerShell (Windows)
$cred = gcloud auth print-access-token $headers = @{ "X-Goog-User-Project" = "BILLING_PROJECT_ID"; "Authorization" = "Bearer $cred" } $body = @" { "contentType": "RESOURCE", "readTime": "2024-01-30T00:00:00Z", "outputConfig": { "gcsDestination": { "uri": "gs://my-bucket/my-file" } } } "@ Invoke-WebRequest ` -Method POST ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -Body $body ` -Uri "https://cloudasset.googleapis.com/v1/projects/my-project:exportAssets" | Select-Object -Expand Content
Exemplo de resposta
{ "name": "projects/000000000000/operations/ExportAssets/RESOURCE/00000000000000000000000000000000", "metadata": { "@type": "type.googleapis.com/google.cloud.asset.v1.ExportAssetsRequest", "parent": "projects/000000000000", "readTime": "2024-01-30T00:00:00Z", "contentType": "RESOURCE", "outputConfig": { "gcsDestination": { "uri": "gs://my-bucket/export.txt" } } } }
C#
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Ir
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Java
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Node.js
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
PHP
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Python
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Ruby
Para saber como instalar e usar a biblioteca de cliente do Cloud Asset Inventory, consulte o artigo Bibliotecas de cliente do Cloud Asset Inventory.
Para se autenticar no Cloud Asset Inventory, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Verifique o estado de uma exportação
As exportações demoram algum tempo a concluir. Para verificar se uma exportação está concluída, pode consultar a operação através do respetivo ID da operação.
Tenha em atenção que, mesmo que a exportação esteja concluída, alguém pode ter feito outro pedido de exportação para o mesmo destino como uma operação diferente. Podem ser feitos novos pedidos de exportação para o mesmo destino após a conclusão de um pedido anterior ou se tiverem decorrido mais de 15 minutos. Os pedidos de exportação feitos fora destas condições são rejeitados pelo Cloud Asset Inventory.
gcloud
Para ver o estado da exportação, siga estas instruções:
Obtenha o
OPERATION_PATH
, que inclui o ID da operação, na resposta ao seu pedido de exportação. O elementoOPERATION_PATH
é apresentado na resposta à exportação, que está formatada da seguinte forma:projects/PROJECT_NUMBER/operations/ExportAssets/CONTENT_TYPE/OPERATION_ID
Para verificar o estado da exportação, execute o seguinte comando com o parâmetro
OPERATION_PATH
:gcloud asset operations describe OPERATION_PATH
REST
Para ver o estado da exportação, siga estas instruções:
Obtenha o
OPERATION_PATH
, que inclui o ID da operação, na resposta ao seu pedido de exportação. O elementoOPERATION_PATH
é apresentado como o valor do camponame
na resposta à exportação, que está formatada da seguinte forma:projects/PROJECT_NUMBER/operations/ExportAssets/CONTENT_TYPE/OPERATION_ID
Para verificar o estado da exportação, faça o seguinte pedido.
REST
Método HTTP e URL:
GET https://cloudasset.googleapis.com/v1/OPERATION_PATH
Exemplos de comandos
curl (Linux, macOS ou Cloud Shell)
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ https://cloudasset.googleapis.com/v1/OPERATION_PATH
PowerShell (Windows)
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://cloudasset.googleapis.com/v1/OPERATION_PATH" | Select-Object -Expand Content
Exemplo de resposta
{ "name": "projects/000000000000/operations/ExportAssets/RESOURCE/00000000000000000000000000000000", "metadata": { "@type": "type.googleapis.com/google.cloud.asset.v1.ExportAssetsRequest", "parent": "projects/000000000000", "readTime": "2024-01-30T00:00:00Z", "contentType": "RESOURCE", "outputConfig": { "gcsDestination": { "uri": "gs://my-bucket/export.txt" } } } }
Veja um resumo do recurso
Para ver o instantâneo do recurso:
Aceda à página Recipientes do Cloud Storage na Google Cloud consola.
Clique no nome do contentor para o qual exportou a imagem instantânea do recurso e, de seguida, clique no nome do ficheiro de exportação.
Clique em Transferir para transferir a imagem instantânea do recurso e abra-a no editor de texto da sua escolha.