os_policy_assignments
Creates, updates, deletes, gets or lists a os_policy_assignments resource.
Overview
| Name | os_policy_assignments |
| Type | Resource |
| Id | google.osconfig.os_policy_assignments |
Fields
| Name | Datatype | Description |
|---|---|---|
name | string | Resource name. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id} 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. |
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. |
etag | string | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. |
instanceFilter | object | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. |
osPolicies | array | Required. List of OS policies to be applied to the VMs. |
reconciling | boolean | 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 |
revisionCreateTime | string | Output only. The timestamp that the revision was created. |
revisionId | string | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment |
rollout | object | Message to configure the rollout at the zonal level for the OS policy assignment. |
rolloutState | string | Output only. OS policy assignment rollout state |
uid | string | Output only. Server generated unique id for the OS policy assignment resource. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | locationsId, osPolicyAssignmentsId, projectsId | Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter. |
list | SELECT | locationsId, projectsId | List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. |
create | INSERT | locationsId, projectsId | Create an OS policy assignment. This method also creates the first 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. |
delete | DELETE | locationsId, osPolicyAssignmentsId, projectsId | Delete the 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. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel. |
patch | UPDATE | locationsId, osPolicyAssignmentsId, projectsId | 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. |
SELECT examples
List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.
SELECT
name,
description,
baseline,
deleted,
etag,
instanceFilter,
osPolicies,
reconciling,
revisionCreateTime,
revisionId,
rollout,
rolloutState,
uid
FROM google.osconfig.os_policy_assignments
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';
INSERT example
Use the following StackQL query and manifest file to create a new os_policy_assignments resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.osconfig.os_policy_assignments (
locationsId,
projectsId,
name,
description,
osPolicies,
instanceFilter,
rollout,
etag
)
SELECT
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ description }}',
'{{ osPolicies }}',
'{{ instanceFilter }}',
'{{ rollout }}',
'{{ etag }}'
;
- name: your_resource_model_name
props:
- name: name
value: string
- name: description
value: string
- name: osPolicies
value:
- - name: id
value: string
- name: description
value: string
- name: mode
value: string
- name: resourceGroups
value:
- - name: inventoryFilters
value:
- - name: osShortName
value: string
- name: osVersion
value: string
- name: resources
value:
- - name: id
value: string
- name: pkg
value:
- name: desiredState
value: string
- name: apt
value:
- name: name
value: string
- name: deb
value:
- name: source
value:
- name: remote
value:
- name: uri
value: string
- name: sha256Checksum
value: string
- name: gcs
value:
- name: bucket
value: string
- name: object
value: string
- name: generation
value: string
- name: localPath
value: string
- name: allowInsecure
value: boolean
- name: pullDeps
value: boolean
- name: yum
value:
- name: name
value: string
- name: zypper
value:
- name: name
value: string
- name: rpm
value:
- name: pullDeps
value: boolean
- name: googet
value:
- name: name
value: string
- name: msi
value:
- name: properties
value:
- string
- name: repository
value:
- name: apt
value:
- name: archiveType
value: string
- name: uri
value: string
- name: distribution
value: string
- name: components
value:
- string
- name: gpgKey
value: string
- name: yum
value:
- name: id
value: string
- name: displayName
value: string
- name: baseUrl
value: string
- name: gpgKeys
value:
- string
- name: zypper
value:
- name: id
value: string
- name: displayName
value: string
- name: baseUrl
value: string
- name: gpgKeys
value:
- string
- name: goo
value:
- name: name
value: string
- name: url
value: string
- name: exec
value:
- name: validate
value:
- name: script
value: string
- name: args
value:
- string
- name: interpreter
value: string
- name: outputFilePath
value: string
- name: file
value:
- name: content
value: string
- name: path
value: string
- name: state
value: string
- name: permissions
value: string
- name: allowNoResourceGroupMatch
value: boolean
- name: instanceFilter
value:
- name: all
value: boolean
- name: inclusionLabels
value:
- - name: labels
value: object
- name: exclusionLabels
value:
- - name: labels
value: object
- name: inventories
value:
- - name: osShortName
value: string
- name: osVersion
value: string
- name: rollout
value:
- name: disruptionBudget
value:
- name: fixed
value: integer
- name: percent
value: integer
- name: minWaitDuration
value: string
- name: revisionId
value: string
- name: revisionCreateTime
value: string
- name: etag
value: string
- name: rolloutState
value: string
- name: baseline
value: boolean
- name: deleted
value: boolean
- name: reconciling
value: boolean
- name: uid
value: string
UPDATE example
Updates a os_policy_assignments resource.
/*+ update */
UPDATE google.osconfig.os_policy_assignments
SET
name = '{{ name }}',
description = '{{ description }}',
osPolicies = '{{ osPolicies }}',
instanceFilter = '{{ instanceFilter }}',
rollout = '{{ rollout }}',
etag = '{{ etag }}'
WHERE
locationsId = '{{ locationsId }}'
AND osPolicyAssignmentsId = '{{ osPolicyAssignmentsId }}'
AND projectsId = '{{ projectsId }}';
DELETE example
Deletes the specified os_policy_assignments resource.
/*+ delete */
DELETE FROM google.osconfig.os_policy_assignments
WHERE locationsId = '{{ locationsId }}'
AND osPolicyAssignmentsId = '{{ osPolicyAssignmentsId }}'
AND projectsId = '{{ projectsId }}';