Method: projects.locations.connections.patch

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

HTTP request

PATCH https://bigqueryconnection.googleapis.com/v1beta1/{name=projects/*/locations/*/connections/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connectionId}

Authorization requires the following Google IAM permission on the specified resource name:

  • bigquery.connections.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Update mask for the connection fields to be updated.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Connection.

Response body

If successful, the response body contains an instance of Connection.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!