REST Resource: projects.locations.osPolicyAssignments

Resource: OSPolicyAssignment
- JSON representation
Methods

Resource: OSPolicyAssignment

OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances.

An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script.

For more information about the OS policy resource definitions and examples, see OS policy and OS policy assignment .

JSON representation

JSON representation
{ "name" : string , "description" : string , "osPolicies" : [ { object ( `OSPolicy` ) } ] , "instanceFilter" : { object ( `InstanceFilter` ) } , "rollout" : { object ( `Rollout` ) } , "revisionId" : string , "revisionCreateTime" : string , "etag" : string , "rolloutState" : enum ( `RolloutState` ) , "baseline" : boolean , "deleted" : boolean , "reconciling" : boolean , "uid" : string }

 { 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "osPolicies" 
 : 
 [ 
 { 
 object (  OSPolicy 
 
) 
 } 
 ] 
 , 
 "instanceFilter" 
 : 
 { 
 object (  InstanceFilter 
 
) 
 } 
 , 
 "rollout" 
 : 
 { 
 object (  Rollout 
 
) 
 } 
 , 
 "revisionId" 
 : 
 string 
 , 
 "revisionCreateTime" 
 : 
 string 
 , 
 "etag" 
 : 
 string 
 , 
 "rolloutState" 
 : 
 enum (  RolloutState 
 
) 
 , 
 "baseline" 
 : 
 boolean 
 , 
 "deleted" 
 : 
 boolean 
 , 
 "reconciling" 
 : 
 boolean 
 , 
 "uid" 
 : 
 string 
 }

Fields
`name`	`string` Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{osPolicyAssignmentId}` This field is ignored when you create an OS policy assignment.
`description`	`string` OS policy assignment description. Length of the description is limited to 1024 characters.
`osPolicies[]`	`object ( OSPolicy )` Required. List of OS policies to be applied to the VMs.
`instanceFilter`	`object ( InstanceFilter )` Required. Filter to select VMs.
`rollout`	`object ( Rollout )` Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instanceFilter - osPolicies 3) OSPolicyAssignment is deleted.
`revisionId`	`string` Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment
`revisionCreateTime`	`string ( Timestamp format)` Output only. The timestamp that the revision was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .
`etag`	`string` The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
`rolloutState`	`enum ( RolloutState )` Output only. OS policy assignment rollout state
`baseline`	`boolean` Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
`deleted`	`boolean` Output only. Indicates that this revision deletes the OS policy assignment.
`reconciling`	`boolean` Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rolloutState` is one of: * IN_PROGRESS * CANCELLING
`uid`	`string` Output only. Server generated unique id for the OS policy assignment resource.

Methods
`create`	Create an OS policy assignment.
`delete`	Delete the OS policy assignment.
`get`	Retrieve an existing OS policy assignment.
`list`	List the OS policy assignments under the parent resource.
`listRevisions`	List the OS policy assignment revisions for a given OS policy assignment.
`patch`	Update an existing OS policy assignment.

REST Resource: projects.locations.osPolicyAssignments

Resource: OSPolicyAssignment

Methods

`create`

`delete`

`get`

`list`

`listRevisions`

`patch`