Method: projects.locations.migrationJobs.generateTcpProxyScript

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

HTTP request

POST https://datamigration.googleapis.com/v1/{migrationJob}:generateTcpProxyScript

Path parameters

Parameters
migrationJob

string

Name of the migration job resource to generate the TCP Proxy script.

Authorization requires the following IAM permission on the specified resource migrationJob:

  • datamigration.migrationjobs.generateTcpProxyScript

Request body

The request body contains data with the following structure:

JSON representation 
{
  "vmName": string,
  "vmMachineType": string,
  "vmZone": string,
  "vmSubnet": string
}
Fields
vmName

string

Required. The name of the Compute instance that will host the proxy.
vmMachineType

string

Required. The type of the Compute instance that will host the proxy.
vmZone

string

Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example "us-central1-b". If not specified, uses the "-b" zone of the destination Connection Profile's region.
vmSubnet

string

Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.

Response body

Response message for 'migrationJobs.generateTcpProxyScript' request.

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

JSON representation 
{
  "script": string
}
Fields
script

string

The TCP Proxy configuration script.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.