Method: projects.locations.osPolicyAssignments.patch

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

HTTP request

PATCH https://osconfig.googleapis.com/v1alpha/{osPolicyAssignment.name=projects/*/locations/*/osPolicyAssignments/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
osPolicyAssignment.name

string

Resource name.

Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{osPolicyAssignmentId}

This field is ignored when you create an OS policy assignment.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask that controls which fields of the assignment should be updated.

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

boolean

Optional. If set to true, and the OS policy assignment is not found, a new OS policy assignment will be created. In this situation, updateMask is ignored.
requestId

string

Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a requestId is provided.

Request body

The request body contains an instance of OSPolicyAssignment.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • osconfig.osPolicyAssignments.update

For more information, see the IAM documentation.