Method: projects.locations.global.connectivityTests.patch

Updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.

If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of

UNKNOWN

.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for more details.

HTTP request

PATCH https://networkmanagement.googleapis.com/v1beta1/{resource.name=projects/*/locations/global/connectivityTests/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource.name

string

Identifier. Unique name of the resource using the form: projects/{projectId}/locations/global/connectivityTests/{test}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask of fields to update. At least one path must be supplied in this field.

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

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

  • networkmanagement.connectivitytests.update

Request body

The request body contains an instance of ConnectivityTest.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.