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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis endpoint generates a TCP Proxy configuration script for a cloud-hosted VM, using the \u003ccode\u003ePOST\u003c/code\u003e method with a specific URL structure.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emigrationJob\u003c/code\u003e path parameter, a string representing the migration job resource name, is required and necessitates a specific IAM permission (\u003ccode\u003edatamigration.migrationjobs.generateTcpProxyScript\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires details of the target VM including \u003ccode\u003evmName\u003c/code\u003e, \u003ccode\u003evmMachineType\u003c/code\u003e, and \u003ccode\u003evmSubnet\u003c/code\u003e, and optionally \u003ccode\u003evmZone\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns a JSON response body containing a single field, \u003ccode\u003escript\u003c/code\u003e, which holds the generated TCP Proxy configuration script as a string.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.migrationJobs.generateTcpProxyScript\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.TcpProxyScript.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nGenerate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.\n\n### HTTP request\n\n`POST https://datamigration.googleapis.com/v1/{migrationJob}:generateTcpProxyScript`\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nResponse message for 'migrationJobs.generateTcpProxyScript' request.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
