Show / Hide Table of Contents

Class InstanceOSPoliciesCompliance

This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see View compliance.

Inheritance
object
InstanceOSPoliciesCompliance
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.OSConfig.v1alpha.Data
Assembly: Google.Apis.OSConfig.v1alpha.dll
Syntax
public class InstanceOSPoliciesCompliance : IDirectResponseSchema

Properties

DetailedState

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN. It may contain one of the following values: * no-compliance-data: Compliance data is not available for this VM. * no-agent-detected: OS Config agent is not detected for this VM. * config-not-supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management. * inactive: VM is not running. * internal-service-errors: There were internal service errors encountered while enforcing compliance. * agent-errors: OS config agent encountered errors while enforcing compliance.

Declaration
[JsonProperty("detailedState")]
public virtual string DetailedState { get; set; }
Property Value
Type Description
string

DetailedStateReason

Output only. The reason for the detailed_state of the VM (if any).

Declaration
[JsonProperty("detailedStateReason")]
public virtual string DetailedStateReason { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Instance

Output only. The Compute Engine VM instance name.

Declaration
[JsonProperty("instance")]
public virtual string Instance { get; set; }
Property Value
Type Description
string

LastComplianceCheckTime

object representation of LastComplianceCheckTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastComplianceCheckTimeDateTimeOffset instead.")]
public virtual object LastComplianceCheckTime { get; set; }
Property Value
Type Description
object

LastComplianceCheckTimeDateTimeOffset

DateTimeOffset representation of LastComplianceCheckTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastComplianceCheckTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastComplianceCheckTimeRaw

Output only. Timestamp of the last compliance check for the VM.

Declaration
[JsonProperty("lastComplianceCheckTime")]
public virtual string LastComplianceCheckTimeRaw { get; set; }
Property Value
Type Description
string

LastComplianceRunId

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.

Declaration
[JsonProperty("lastComplianceRunId")]
public virtual string LastComplianceRunId { get; set; }
Property Value
Type Description
string

Name

Output only. The InstanceOSPoliciesCompliance API resource name. Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OsPolicyCompliances

Output only. Compliance data for each OSPolicy that is applied to the VM.

Declaration
[JsonProperty("osPolicyCompliances")]
public virtual IList<InstanceOSPoliciesComplianceOSPolicyCompliance> OsPolicyCompliances { get; set; }
Property Value
Type Description
IList<InstanceOSPoliciesComplianceOSPolicyCompliance>

State

Output only. Compliance state of the VM.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX