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
Inherited Members
Namespace: Google.Apis.Compute.beta.Data
Assembly: Google.Apis.Compute.beta.dll
Syntax
public class InstanceGroupManager : IDirectResponseSchema

Properties

AllInstancesConfig

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

Declaration
[JsonProperty("allInstancesConfig")]
public virtual InstanceGroupManagerAllInstancesConfig AllInstancesConfig { get; set; }
Property Value
Type Description
InstanceGroupManagerAllInstancesConfig

AutoHealingPolicies

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

Declaration
[JsonProperty("autoHealingPolicies")]
public virtual IList<InstanceGroupManagerAutoHealingPolicy> AutoHealingPolicies { get; set; }
Property Value
Type Description
IList<InstanceGroupManagerAutoHealingPolicy>

BaseInstanceName

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

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

CreationTimestamp

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

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

CurrentActions

[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.

Declaration
[JsonProperty("currentActions")]
public virtual InstanceGroupManagerActionsSummary CurrentActions { get; set; }
Property Value
Type Description
InstanceGroupManagerActionsSummary

Description

An optional description of this resource.

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

DistributionPolicy

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

Declaration
[JsonProperty("distributionPolicy")]
public virtual DistributionPolicy DistributionPolicy { get; set; }
Property Value
Type Description
DistributionPolicy

ETag

The ETag of the item.

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

FailoverAction

The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

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

Fingerprint

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.

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

Id

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

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

InstanceFlexibilityPolicy

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

Declaration
[JsonProperty("instanceFlexibilityPolicy")]
public virtual InstanceGroupManagerInstanceFlexibilityPolicy InstanceFlexibilityPolicy { get; set; }
Property Value
Type Description
InstanceGroupManagerInstanceFlexibilityPolicy

InstanceGroup

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

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

InstanceLifecyclePolicy

The repair policy for this managed instance group.

Declaration
[JsonProperty("instanceLifecyclePolicy")]
public virtual InstanceGroupManagerInstanceLifecyclePolicy InstanceLifecyclePolicy { get; set; }
Property Value
Type Description
InstanceGroupManagerInstanceLifecyclePolicy

InstanceTemplate

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.

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

Kind

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

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

ListManagedInstancesResults

Pagination behavior of the listManagedInstances API method for this managed instance group.

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

MultiMig

URL to the multi-MIG that this Managed Instance Group belongs to.

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

Name

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

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

NamedPorts

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

Declaration
[JsonProperty("namedPorts")]
public virtual IList<NamedPort> NamedPorts { get; set; }
Property Value
Type Description
IList<NamedPort>

Params__

Input only. Additional params passed with the request, but not persisted as part of resource payload.

Declaration
[JsonProperty("params")]
public virtual InstanceGroupManagerParams Params__ { get; set; }
Property Value
Type Description
InstanceGroupManagerParams

Region

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

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

ResourcePolicies

Resource policies for this managed instance group.

Declaration
[JsonProperty("resourcePolicies")]
public virtual InstanceGroupManagerResourcePolicies ResourcePolicies { get; set; }
Property Value
Type Description
InstanceGroupManagerResourcePolicies

SatisfiesPzi

[Output Only] Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

[Output Only] Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

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

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

ServiceAccount

The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.

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

StandbyPolicy

Standby policy for stopped and suspended instances.

Declaration
[JsonProperty("standbyPolicy")]
public virtual InstanceGroupManagerStandbyPolicy StandbyPolicy { get; set; }
Property Value
Type Description
InstanceGroupManagerStandbyPolicy

StatefulPolicy

Stateful configuration for this Instanced Group Manager

Declaration
[JsonProperty("statefulPolicy")]
public virtual StatefulPolicy StatefulPolicy { get; set; }
Property Value
Type Description
StatefulPolicy

Status

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

Declaration
[JsonProperty("status")]
public virtual InstanceGroupManagerStatus Status { get; set; }
Property Value
Type Description
InstanceGroupManagerStatus

TargetPools

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.

Declaration
[JsonProperty("targetPools")]
public virtual IList<string> TargetPools { get; set; }
Property Value
Type Description
IList<string>

TargetSize

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.

Declaration
[JsonProperty("targetSize")]
public virtual int? TargetSize { get; set; }
Property Value
Type Description
int?

TargetStoppedSize

The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.

Declaration
[JsonProperty("targetStoppedSize")]
public virtual int? TargetStoppedSize { get; set; }
Property Value
Type Description
int?

TargetSuspendedSize

The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.

Declaration
[JsonProperty("targetSuspendedSize")]
public virtual int? TargetSuspendedSize { get; set; }
Property Value
Type Description
int?

UpdatePolicy

The update policy for this managed instance group.

Declaration
[JsonProperty("updatePolicy")]
public virtual InstanceGroupManagerUpdatePolicy UpdatePolicy { get; set; }
Property Value
Type Description
InstanceGroupManagerUpdatePolicy

Versions

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.

Declaration
[JsonProperty("versions")]
public virtual IList<InstanceGroupManagerVersion> Versions { get; set; }
Property Value
Type Description
IList<InstanceGroupManagerVersion>

Zone

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

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

Implements