Google Cloud OS Config v1alpha API - Class OSPolicy (2.0.0-alpha03) 

public sealed class OSPolicy : IMessage<OSPolicy>, IEquatable<OSPolicy>, IDeepCloneable<OSPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud OS Config v1alpha API class OSPolicy.

An OS policy defines the desired state configuration for a VM.

Inheritance

object > OSPolicy

Namespace

Google.Cloud.OsConfig.V1Alpha

Assembly

Google.Cloud.OsConfig.V1Alpha.dll

Constructors

OSPolicy()

public OSPolicy()

OSPolicy(OSPolicy)

public OSPolicy(OSPolicy other)
Parameter
NameDescription
otherOSPolicy

Properties

AllowNoResourceGroupMatch

public bool AllowNoResourceGroupMatch { get; set; }

This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to true if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.

Property Value
TypeDescription
bool

Description

public string Description { get; set; }

Policy description. Length of the description is limited to 1024 characters.

Property Value
TypeDescription
string

Id

public string Id { get; set; }

Required. The id of the OS policy with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the assignment.
Property Value
TypeDescription
string

Mode

public OSPolicy.Types.Mode Mode { get; set; }

Required. Policy mode

Property Value
TypeDescription
OSPolicyTypesMode

ResourceGroups

public RepeatedField<OSPolicy.Types.ResourceGroup> ResourceGroups { get; }

Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored.

If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag allow_no_resource_group_match

Property Value
TypeDescription
RepeatedFieldOSPolicyTypesResourceGroup