OSPolicyAssignment

import type { OSPolicyAssignment } from "https://googleapis.deno.dev/v1/osconfig:v2.ts";

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.

interface OSPolicyAssignment {

readonly baseline?: boolean;

readonly deleted?: boolean;

description?: string;

etag?: string;

instanceFilter?: OSPolicyAssignmentInstanceFilter;

name?: string;

osPolicies?: OSPolicy[];

readonly reconciling?: boolean;

readonly revisionCreateTime?: Date;

readonly revisionId?: string;

rollout?: OSPolicyAssignmentRollout;

readonly rolloutState?:

| "ROLLOUT_STATE_UNSPECIFIED"

| "IN_PROGRESS"

| "CANCELLING"

| "CANCELLED"

| "SUCCEEDED";

readonly uid?: string;

}

§Properties

readonly baseline?: boolean

[src]

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.

readonly deleted?: boolean

[src]

Output only. Indicates that this revision deletes the OS policy assignment.

description?: string

[src]

OS policy assignment description. Length of the description is limited to 1024 characters.

etag?: string

[src]

The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.

instanceFilter?: OSPolicyAssignmentInstanceFilter

[src]

Required. Filter to select VMs.

name?: string

[src]

Resource name. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id} This field is ignored when you create an OS policy assignment.

osPolicies?: OSPolicy[]

[src]

Required. List of OS policies to be applied to the VMs.

readonly reconciling?: boolean

[src]

Output only. Indicates that reconciliation is in progress for the revision. This value is true when the rollout_state is one of: * IN_PROGRESS * CANCELLING

readonly revisionCreateTime?: Date

[src]

Output only. The timestamp that the revision was created.

readonly revisionId?: string

[src]

Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment

rollout?: OSPolicyAssignmentRollout

[src]

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: - instance_filter - os_policies 3) OSPolicyAssignment is deleted.

readonly rolloutState?: "ROLLOUT_STATE_UNSPECIFIED" | "IN_PROGRESS" | "CANCELLING" | "CANCELLED" | "SUCCEEDED"

[src]

Output only. OS policy assignment rollout state

readonly uid?: string

[src]

Output only. Server generated unique id for the OS policy assignment resource.