Compute Engine v1 API - Class InstanceGroupManager (3.1.0)

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

Reference documentation and code samples for the Compute Engine v1 API class InstanceGroupManager.

Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.

Inheritance

object > InstanceGroupManager

Implements

IMessage InstanceGroupManager, IEquatable InstanceGroupManager, IDeepCloneable InstanceGroupManager, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

InstanceGroupManager()

public InstanceGroupManager()

InstanceGroupManager(InstanceGroupManager)

public InstanceGroupManager(InstanceGroupManager other)

Parameter
Name	Description
`other`	`InstanceGroupManager`

Properties

AllInstancesConfig

public InstanceGroupManagerAllInstancesConfig AllInstancesConfig { get; set; }

Specifies configuration that overrides the instance template configuration for the group.

Property Value
Type	Description
`InstanceGroupManagerAllInstancesConfig`

AutoHealingPolicies

public RepeatedField<InstanceGroupManagerAutoHealingPolicy> AutoHealingPolicies { get; }

The autohealing policy for this managed instance group. You can specify only one value.

Property Value
Type	Description
`RepeatedFieldInstanceGroupManagerAutoHealingPolicy`

BaseInstanceName

public string BaseInstanceName { get; set; }

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z

Property Value
Type	Description
`string`

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

Property Value
Type	Description
`string`

CurrentActions

public InstanceGroupManagerActionsSummary CurrentActions { get; set; }

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

Property Value
Type	Description
`InstanceGroupManagerActionsSummary`

Description

public string Description { get; set; }

An optional description of this resource.

Property Value
Type	Description
`string`

DistributionPolicy

public DistributionPolicy DistributionPolicy { get; set; }

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

Property Value
Type	Description
`DistributionPolicy`

Fingerprint

public string Fingerprint { get; set; }

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

Property Value
Type	Description
`string`

HasBaseInstanceName

public bool HasBaseInstanceName { get; }

Gets whether the "base_instance_name" field is set

Property Value
Type	Description
`bool`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasFingerprint

public bool HasFingerprint { get; }

Gets whether the "fingerprint" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasInstanceGroup

public bool HasInstanceGroup { get; }

Gets whether the "instance_group" field is set

Property Value
Type	Description
`bool`

HasInstanceTemplate

public bool HasInstanceTemplate { get; }

Gets whether the "instance_template" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasListManagedInstancesResults

public bool HasListManagedInstancesResults { get; }

Gets whether the "list_managed_instances_results" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasSatisfiesPzi

public bool HasSatisfiesPzi { get; }

Gets whether the "satisfies_pzi" field is set

Property Value
Type	Description
`bool`

HasSatisfiesPzs

public bool HasSatisfiesPzs { get; }

Gets whether the "satisfies_pzs" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HasTargetSize

public bool HasTargetSize { get; }

Gets whether the "target_size" field is set

Property Value
Type	Description
`bool`

HasZone

public bool HasZone { get; }

Gets whether the "zone" field is set

Property Value
Type	Description
`bool`

Id

public ulong Id { get; set; }

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Property Value
Type	Description
`ulong`

InstanceFlexibilityPolicy

public InstanceGroupManagerInstanceFlexibilityPolicy InstanceFlexibilityPolicy { get; set; }

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

Property Value
Type	Description
`InstanceGroupManagerInstanceFlexibilityPolicy`

InstanceGroup

public string InstanceGroup { get; set; }

[Output Only] The URL of the Instance Group resource.

Property Value
Type	Description
`string`

InstanceLifecyclePolicy

public InstanceGroupManagerInstanceLifecyclePolicy InstanceLifecyclePolicy { get; set; }

The repair policy for this managed instance group.

Property Value
Type	Description
`InstanceGroupManagerInstanceLifecyclePolicy`

InstanceTemplate

public string InstanceTemplate { get; set; }

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Property Value
Type	Description
`string`

Kind

public string Kind { get; set; }

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

Property Value
Type	Description
`string`

ListManagedInstancesResults

public string ListManagedInstancesResults { get; set; }

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

Property Value
Type	Description
`string`

NamedPorts

public RepeatedField<NamedPort> NamedPorts { get; }

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

Property Value
Type	Description
`RepeatedFieldNamedPort`

Region

public string Region { get; set; }

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

Property Value
Type	Description
`string`

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

[Output Only] Reserved for future use.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

[Output Only] Reserved for future use.

Property Value
Type	Description
`bool`

SelfLink

public string SelfLink { get; set; }

[Output Only] The URL for this managed instance group. The server defines this URL.

Property Value
Type	Description
`string`

StatefulPolicy

public StatefulPolicy StatefulPolicy { get; set; }

Stateful configuration for this Instanced Group Manager

Property Value
Type	Description
`StatefulPolicy`

Status

public InstanceGroupManagerStatus Status { get; set; }

[Output Only] The status of this managed instance group.

Property Value
Type	Description
`InstanceGroupManagerStatus`

TargetPools

public RepeatedField<string> TargetPools { get; }

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Property Value
Type	Description
`RepeatedFieldstring`

TargetSize

public int TargetSize { get; set; }

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

Property Value
Type	Description
`int`

UpdatePolicy

public InstanceGroupManagerUpdatePolicy UpdatePolicy { get; set; }

The update policy for this managed instance group.

Property Value
Type	Description
`InstanceGroupManagerUpdatePolicy`

Versions

public RepeatedField<InstanceGroupManagerVersion> Versions { get; }

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

Property Value
Type	Description
`RepeatedFieldInstanceGroupManagerVersion`

Zone

public string Zone { get; set; }

[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Property Value
Type	Description
`string`