Class InstanceGroupsResource

The "instanceGroups" collection of methods.

Inheritance

object

InstanceGroupsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Compute.v1

Assembly: Google.Apis.Compute.v1.dll

Syntax

public class InstanceGroupsResource

Constructors

InstanceGroupsResource(IClientService)

Constructs a new resource.

Declaration

public InstanceGroupsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AddInstances(InstanceGroupsAddInstancesRequest, string, string, string)

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

Declaration

public virtual InstanceGroupsResource.AddInstancesRequest AddInstances(InstanceGroupsAddInstancesRequest body, string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
InstanceGroupsAddInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group where you are adding instances.

Returns

Type	Description
InstanceGroupsResource.AddInstancesRequest

AggregatedList(string)

Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Declaration

public virtual InstanceGroupsResource.AggregatedListRequest AggregatedList(string project)

Parameters

Type	Name	Description
string	project	Project ID for this request.

Returns

Type	Description
InstanceGroupsResource.AggregatedListRequest

Delete(string, string, string)

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

Declaration

public virtual InstanceGroupsResource.DeleteRequest Delete(string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group to delete.

Returns

Type	Description
InstanceGroupsResource.DeleteRequest

Get(string, string, string)

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Declaration

public virtual InstanceGroupsResource.GetRequest Get(string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group.

Returns

Type	Description
InstanceGroupsResource.GetRequest

Insert(InstanceGroup, string, string)

Creates an instance group in the specified project using the parameters that are included in the request.

Declaration

public virtual InstanceGroupsResource.InsertRequest Insert(InstanceGroup body, string project, string zone)

Parameters

Type	Name	Description
InstanceGroup	body	The body of the request.
string	project	Project ID for this request.
string	zone	The name of the zone where you want to create the instance group.

Returns

Type	Description
InstanceGroupsResource.InsertRequest

List(string, string)

Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Declaration

public virtual InstanceGroupsResource.ListRequest List(string project, string zone)

Parameters

Type	Name	Description
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.

Returns

Type	Description
InstanceGroupsResource.ListRequest

ListInstances(InstanceGroupsListInstancesRequest, string, string, string)

Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators.

Declaration

public virtual InstanceGroupsResource.ListInstancesRequest ListInstances(InstanceGroupsListInstancesRequest body, string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
InstanceGroupsListInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group from which you want to generate a list of included instances.

Returns

Type	Description
InstanceGroupsResource.ListInstancesRequest

RemoveInstances(InstanceGroupsRemoveInstancesRequest, string, string, string)

Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

Declaration

public virtual InstanceGroupsResource.RemoveInstancesRequest RemoveInstances(InstanceGroupsRemoveInstancesRequest body, string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
InstanceGroupsRemoveInstancesRequest	body	The body of the request.
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group where the specified instances will be removed.

Returns

Type	Description
InstanceGroupsResource.RemoveInstancesRequest

SetNamedPorts(InstanceGroupsSetNamedPortsRequest, string, string, string)

Sets the named ports for the specified instance group.

Declaration

public virtual InstanceGroupsResource.SetNamedPortsRequest SetNamedPorts(InstanceGroupsSetNamedPortsRequest body, string project, string zone, string instanceGroup)

Parameters

Type	Name	Description
InstanceGroupsSetNamedPortsRequest	body	The body of the request.
string	project	Project ID for this request.
string	zone	The name of the zone where the instance group is located.
string	instanceGroup	The name of the instance group where the named ports are updated.

Returns

Type	Description
InstanceGroupsResource.SetNamedPortsRequest