Method: analyzeMove

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

HTTP request

GET https://cloudasset.googleapis.com/v1/{resource=*/*}:analyzeMove

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource

string

Required. Name of the resource to perform the analysis against. Only GCP Project are supported as of today. Hence, this can only be Project ID (such as "projects/my-project-id") or a Project Number (such as "projects/12345").

Query parameters

Parameters
destinationParent

string

Required. Name of the GCP Folder or Organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a Folder number (such as "folders/123") or an Organization number (such as "organizations/123").

view

enum (AnalysisView)

Analysis view indicating what information should be included in the analysis response. If unspecified, the default view is FULL.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response message for resource move analysis.

JSON representation
{
  "moveAnalysis": [
    {
      object (MoveAnalysis)
    }
  ]
}
Fields
moveAnalysis[]

object (MoveAnalysis)

The list of analyses returned from performing the intended resource move analysis. The analysis is grouped by different Cloud services.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AnalysisView

View enum for supporting partial analysis responses.

Enums
ANALYSIS_VIEW_UNSPECIFIED The default/unset value. The API will default to the FULL view.
FULL Full analysis including all level of impacts of the specified resource move.
BASIC Basic analysis only including blockers which will prevent the specified resource move at runtime.

MoveAnalysis

A message to group the analysis information.

JSON representation
{
  "displayName": string,

  // Union field result can be only one of the following:
  "analysis": {
    object (MoveAnalysisResult)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Fields
displayName

string

The user friendly display name of the analysis. E.g. IAM, Organization Policy etc.

Union field result.

result can be only one of the following:

analysis

object (MoveAnalysisResult)

Analysis result of moving the target resource.

error

object (Status)

Description of error encountered when performing the analysis.

MoveAnalysisResult

An analysis result including blockers and warnings.

JSON representation
{
  "blockers": [
    {
      object (MoveImpact)
    }
  ],
  "warnings": [
    {
      object (MoveImpact)
    }
  ]
}
Fields
blockers[]

object (MoveImpact)

Blocking information that would prevent the target resource from moving to the specified destination at runtime.

warnings[]

object (MoveImpact)

Warning information indicating that moving the target resource to the specified destination might be unsafe. This can include important policy information and configuration changes, but will not block moves at runtime.

MoveImpact

A message to group impacts of moving the target resource.

JSON representation
{
  "detail": string
}
Fields
detail

string

User friendly impact detail in a free form message.