Method: projects.patchDeployments.pause

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

POST https://osconfig.googleapis.com/v1beta/{name=projects/*/patchDeployments/*}:pause

The URL uses gRPC Transcoding syntax.

Parameters
name

string

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • osconfig.patchDeployments.pause

For more information, see the IAM documentation.